Merge pull request #3 from amirreza8002/structure

restructure project directories

Author: amirreza8002

django_async_extensions/aforms/__init__.py

@@ -0,0 +1,4 @@
+from django_async_extensions.forms.models import AsyncModelForm
+
+
+__all__ = ("AsyncModelForm",)

django_async_extensions/acontrib/__init__.py renamed to django_async_extensions/contrib/__init__.py

@@ -4,7 +4,7 @@
 
 from django.forms.models import ModelForm
 
-from django_async_extensions.aforms.utils import AsyncRenderableFormMixin
+from django_async_extensions.forms.utils import AsyncRenderableFormMixin
 
 
 class AsyncModelForm(AsyncRenderableFormMixin, ModelForm):

django_async_extensions/acontrib/auth/__init__.py renamed to django_async_extensions/contrib/auth/__init__.py

@@ -1,9 +1,9 @@
-from django_async_extensions.aviews.generic.base import (
+from django_async_extensions.views.generic.base import (
     AsyncView,
     AsyncTemplateView,
     AsyncRedirectView,
 )
-from django_async_extensions.aviews.generic.dates import (
+from django_async_extensions.views.generic.dates import (
     AsyncArchiveIndexView,
     AsyncDateDetailView,
     AsyncDayArchiveView,
@@ -12,14 +12,14 @@
     AsyncWeekArchiveView,
     AsyncYearArchiveView,
 )
-from django_async_extensions.aviews.generic.detail import AsyncDetailView
-from django_async_extensions.aviews.generic.edit import (
+from django_async_extensions.views.generic.detail import AsyncDetailView
+from django_async_extensions.views.generic.edit import (
     AsyncCreateView,
     AsyncDeleteView,
     AsyncFormView,
     AsyncUpdateView,
 )
-from django_async_extensions.aviews.generic.list import AsyncListView
+from django_async_extensions.views.generic.list import AsyncListView
 
 
 __all__ = [

django_async_extensions/acontrib/auth/mixins.py renamed to django_async_extensions/contrib/auth/mixins.py

@@ -15,12 +15,12 @@
     DateMixin,
 )
 
-from django_async_extensions.aviews.generic.base import AsyncView
-from django_async_extensions.aviews.generic.detail import (
+from django_async_extensions.views.generic.base import AsyncView
+from django_async_extensions.views.generic.detail import (
     AsyncBaseDetailView,
     AsyncSingleObjectTemplateResponseMixin,
 )
-from django_async_extensions.aviews.generic.list import (
+from django_async_extensions.views.generic.list import (
     AsyncMultipleObjectMixin,
     AsyncMultipleObjectTemplateResponseMixin,
 )

django_async_extensions/acore/__init__.py renamed to django_async_extensions/core/__init__.py

@@ -3,7 +3,7 @@
 from django.http import Http404
 from django.utils.translation import gettext as _
 
-from django_async_extensions.aviews.generic.base import (
+from django_async_extensions.views.generic.base import (
     AsyncView,
     AsyncContextMixin,
     AsyncTemplateResponseMixin,

django_async_extensions/acore/paginator.py renamed to django_async_extensions/core/paginator.py

@@ -4,13 +4,13 @@
 from django.forms import models as model_forms
 from django.http import HttpResponseRedirect
 
-from django_async_extensions.aforms.models import AsyncModelForm
-from django_async_extensions.aviews.generic.base import (
+from django_async_extensions.forms.models import AsyncModelForm
+from django_async_extensions.views.generic.base import (
     AsyncView,
     AsyncContextMixin,
     AsyncTemplateResponseMixin,
 )
-from django_async_extensions.aviews.generic.detail import (
+from django_async_extensions.views.generic.detail import (
     AsyncSingleObjectMixin,
     AsyncBaseDetailView,
     AsyncSingleObjectTemplateResponseMixin,

django_async_extensions/forms/__init__.py

@@ -4,8 +4,8 @@
 from django.http import Http404
 from django.utils.translation import gettext as _
 
-from django_async_extensions.acore.paginator import AsyncPaginator
-from django_async_extensions.aviews.generic.base import (
+from django_async_extensions.core.paginator import AsyncPaginator
+from django_async_extensions.views.generic.base import (
     AsyncView,
     AsyncContextMixin,
     AsyncTemplateResponseMixin,

django_async_extensions/aforms/models.py renamed to django_async_extensions/forms/models.py

@@ -3,7 +3,7 @@
 django has a set of mixins that help with limiting access and enforcing authentication and permissions,
 but these mixins do not work with async views.
 
-to help with that an async version of the mixins are included in the `acontrib.auth.mixins` module.
+to help with that an async version of the mixins are included in the `contrib.auth.mixins` module.
 
 **note**: these mixins only work with `AsyncView` or classes that inherit from it, or implement the same logic.
 
@@ -16,7 +16,7 @@ works similar to [LoginRequiredMixin](https://docs.djangoproject.com/en/5.1/topi
 also the `dispatch()` method is async.
 
 ```python
-from django_async_extensions.acontrib.auth.mixins import AsyncLoginRequiredMixin
+from django_async_extensions.contrib.auth.mixins import AsyncLoginRequiredMixin
 
 
 class MyView(AsyncLoginRequiredMixin, AsyncView):

django_async_extensions/aforms/utils.py renamed to django_async_extensions/forms/utils.py

@@ -15,7 +15,7 @@ and using querysets in an async environment is different from using querysets in
 #### Example of list pagination
 
 ```pycon
-In [1]: from django_async_extensions.acore.paginator import AsyncPaginator
+In [1]: from django_async_extensions.core.paginator import AsyncPaginator
 
 In [2]: objects = ["john", "paul", "george", "ringo"]
 
@@ -92,7 +92,7 @@ In [2]: objs = [User(username=f"test{i}", password="testpass123") for i in range
 In [3]: User.objects.bulk_create(objs)
 Out[3]: [<User: test1>, <User: test2>, <User: test3>, <User: test4>]
 
-In [4]: from django_async_extensions.acore.paginator import AsyncPaginator
+In [4]: from django_async_extensions.core.paginator import AsyncPaginator
 
 In [5]: users = User.objects.order_by("username")
 

django_async_extensions/amiddleware/__init__.py renamed to django_async_extensions/middleware/__init__.py

@@ -20,7 +20,7 @@ class Author(models.Model):
 
 *Example myapp/forms.py*:
 ```python
-from django_async_extensions.aforms import AsyncModelForm
+from django_async_extensions.forms import AsyncModelForm
 from myapp.models import Author
 
 

django_async_extensions/amiddleware/base.py renamed to django_async_extensions/middleware/base.py

@@ -3,7 +3,7 @@
 async CBVs are supported via the `AsyncView` class.
 
 ```python
-from django_async_extensions.aviews.generic import AsyncView
+from django_async_extensions.views.generic import AsyncView
 
 
 class MyView(AsyncView):
@@ -22,7 +22,7 @@ the `AsyncView` works similar to django's [View](https://docs.djangoproject.com/
 for easy use an async version of `TemplateView` is available
 
 ```python
-from django_async_extensions.aviews.generic import AsyncTemplateView
+from django_async_extensions.views.generic import AsyncTemplateView
 
 class MyTemplateView(AsyncTemplateView):
     template_name = "template.html"
@@ -32,10 +32,10 @@ class MyTemplateView(AsyncTemplateView):
 
 *Ancestors (MRO)*:
 
-1. [django_async_extensions.aviews.generic.base.AsyncTemplateResponseMixin](mixins-simple.md#asynctemplateresponsemixin)
+1. [django_async_extensions.views.generic.base.AsyncTemplateResponseMixin](mixins-simple.md#asynctemplateresponsemixin)
 2. [django.views.generic.base.TemplateResponseMixin](https://docs.djangoproject.com/en/5.1/ref/class-based-views/mixins-simple/#django.views.generic.base.TemplateResponseMixin)
-3. [django_async_extensions.aviews.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
-4. [django_async_extensions.aviews.generic.base.AsyncView](base.md#asyncview)
+3. [django_async_extensions.views.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
+4. [django_async_extensions.views.generic.base.AsyncView](base.md#asyncview)
 5. [django.views.generic.base.View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View)
 
 
@@ -44,7 +44,7 @@ class MyTemplateView(AsyncTemplateView):
 an async version of `RedirectView` is also available
 
 ```python
-from django_async_extensions.aviews.generic import AsyncRedirectView
+from django_async_extensions.views.generic import AsyncRedirectView
 
 class ThisRedirectView(AsyncRedirectView):
     pattern_name = "that-view"
@@ -54,6 +54,6 @@ class ThisRedirectView(AsyncRedirectView):
 
 *Ancestors (MRO)*:
 
-1. [django_async_extensions.aviews.generic.base.AsyncView](base.md#asyncview)
+1. [django_async_extensions.views.generic.base.AsyncView](base.md#asyncview)
 2. [django.views.generic.base.RedirectView](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#redirectview)
 3. [django.views.generic.base.View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View)

django_async_extensions/aviews/__init__.py renamed to django_async_extensions/views/__init__.py

@@ -3,7 +3,7 @@
 `AsyncDetailView` generic view is provided
 
 ```python
-from django_async_extensions.aviews.generic import AsyncDetailView
+from django_async_extensions.views.generic import AsyncDetailView
 
 class MyDetailView(AsyncDetailView):
     model = MyModel
@@ -18,13 +18,13 @@ class MyDetailView(AsyncDetailView):
 
 *Ancestors (MRO)*:
 
-1. [django-async-extensions.aviews.generic.detail.AsyncSingleObjectTemplateResponseMixin](mixins-single-object.md#asyncsingleobjecttemplateresponsemixin)
-2. [django-async-extensions.aviews.generic.base.AsyncTemplateResponseMixin](mixins-simple.md#asynctemplateresponsemixin)
+1. [django-async-extensions.views.generic.detail.AsyncSingleObjectTemplateResponseMixin](mixins-single-object.md#asyncsingleobjecttemplateresponsemixin)
+2. [django-async-extensions.views.generic.base.AsyncTemplateResponseMixin](mixins-simple.md#asynctemplateresponsemixin)
 3. [django.views.generic.base.TemplateResponseMixin](https://docs.djangoproject.com/en/5.1/ref/class-based-views/mixins-simple/#django.views.generic.base.TemplateResponseMixin)
-4. [django_async_extensions.aviews.generic.detail.AsyncBaseDetailView](detail.md#asyncbasedetailview)
-5. [django_async_extensions.aviews.generic.detail.AsyncSingleObjectMixin](mixins-single-object.md#asyncsingleobjectmixin)
-6. [django_async_extensions.aviews.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
-7. [django_async_extensions.aviews.generic.base.AsyncView](base.md#asyncview)
+4. [django_async_extensions.views.generic.detail.AsyncBaseDetailView](detail.md#asyncbasedetailview)
+5. [django_async_extensions.views.generic.detail.AsyncSingleObjectMixin](mixins-single-object.md#asyncsingleobjectmixin)
+6. [django_async_extensions.views.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
+7. [django_async_extensions.views.generic.base.AsyncView](base.md#asyncview)
 8. [django.views.generic.base.View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View)
 
 
@@ -37,7 +37,7 @@ like [BaseDetailView](https://docs.djangoproject.com/en/5.1/ref/class-based-view
 
 *Ancestors (MRO)*:
 
-1. [django_async_extensions.aviews.generic.detail.AsyncSingleObjectMixin](mixins-single-object.md#asyncsingleobjectmixin)
-2. [django_async_extensions.aviews.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
-3. [django_async_extensions.aviews.generic.base.AsyncView](base.md#asyncview)
+1. [django_async_extensions.views.generic.detail.AsyncSingleObjectMixin](mixins-single-object.md#asyncsingleobjectmixin)
+2. [django_async_extensions.views.generic.base.AsyncContextMixin](mixins-simple.md#asynccontextmixin)
+3. [django_async_extensions.views.generic.base.AsyncView](base.md#asyncview)
 4. [django.views.generic.base.View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#django.views.generic.base.View)