documented the base class based views

Author: amirreza8002

django_async_extensions/aviews/generic/base.py

@@ -111,12 +111,18 @@ async def options(self, request, *args, **kwargs):
 
 
 class AsyncTemplateView(TemplateResponseMixin, ContextMixin, AsyncView):
+    """
+    Render a template. Pass keyword arguments from the URLconf to the context.
+    """
+
     async def get(self, request, *args, **kwargs):
         context = self.get_context_data(**kwargs)
         return self.render_to_response(context)
 
 
 class AsyncRedirectView(AsyncView, RedirectView):
+    """Provide a redirect on any GET request."""
+
     async def get(self, request, *args, **kwargs):
         return super().get(request, *args, **kwargs)
 

docs/views/async-class-based-views/base.md

@@ -0,0 +1,45 @@
+## AsyncView
+
+async CBVs are supported via the `AsyncView` class.
+
+```python
+from django_async_extensions.aviews.generic import AsyncView
+
+
+class MyView(AsyncView):
+    pass
+```
+
+the `AsyncView` works similar to django's [View](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#view) class, with a few differences:
+
+1. `AsyncView.as_view()` returns a coroutine.
+2. `AsyncView.dispatch()` is an async function.
+3. http handlers (`def get()`, `def post()`) are expected to be async.
+
+
+## AsyncTemplateView
+
+for easy use an async version of `TemplateView` is available
+
+```python
+from django_async_extensions.aviews.generic import AsyncTemplateView
+
+class MyTemplateView(AsyncTemplateView):
+    template_name = "template.html"
+```
+
+`AsyncTemplateView` works like django's [TemplateView](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#templateview) except that the `get()` method is async.
+
+
+## AsyncRedirectView
+
+an async version of `RedirectView` is also available
+
+```python
+from django_async_extensions.aviews.generic import AsyncRedirectView
+
+class ThisRedirectView(AsyncRedirectView):
+    pattern_name = "that-view"
+```
+
+`AsyncRedirectView` works like django's [RedirectView](https://docs.djangoproject.com/en/5.1/ref/class-based-views/base/#redirectview) except that all http methods are async.