testing automation

Author: eadwinCode

.github/workflows/test_full.yml

@@ -7,25 +7,25 @@ on:
 
 
 jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
-        django-version: ['<2.1', '<2.2', '<3.0', '<3.1', '<3.2', '<3.3', '<4.1']
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v1
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install core
-        run: pip install "Django${{ matrix.django-version }}" pydantic
-      - name: Install tests
-        run: pip install pytest pytest-asyncio pytest-django injector==0.19.0 django-ninja asgiref contextlib2
-      - name: Test
-        run: pytest
+#  test:
+#    runs-on: ubuntu-latest
+#    strategy:
+#      matrix:
+#        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
+#        django-version: ['<2.1', '<2.2', '<3.0', '<3.1', '<3.2', '<3.3', '<4.1']
+#
+#    steps:
+#      - uses: actions/checkout@v2
+#      - name: Set up Python
+#        uses: actions/setup-python@v1
+#        with:
+#          python-version: ${{ matrix.python-version }}
+#      - name: Install core
+#        run: pip install "Django${{ matrix.django-version }}" pydantic
+#      - name: Install tests
+#        run: pip install pytest pytest-asyncio pytest-django injector==0.19.0 django-ninja asgiref contextlib2
+#      - name: Test
+#        run: pytest
   codestyle:
     runs-on: ubuntu-latest
 
@@ -46,4 +46,6 @@ jobs:
       - name: Flake8
         run: flake8 ninja_extra tests
       - name: mypy
-        run: mypy ninja_extra
+        run: mypy ninja_extra
+      - name: Build and Deploy Document
+        run: mkdocs build && mkdocs gh-deploy --force

docs/docs/api_controller/api_controller_permission.md renamed to docs/api_controller/api_controller_permission.md

@@ -1,121 +1,121 @@
-![Test](https://github.com/eadwinCode/django-ninja-extra/workflows/Test/badge.svg)
-[![PyPI version](https://badge.fury.io/py/django-ninja-extra.svg)](https://badge.fury.io/py/django-ninja-extra)
-[![PyPI version](https://img.shields.io/pypi/v/django-ninja-extra.svg)](https://pypi.python.org/pypi/django-ninja-extra)
-[![PyPI version](https://img.shields.io/pypi/pyversions/django-ninja-extra.svg)](https://pypi.python.org/pypi/django-ninja-extra)
-[![PyPI version](https://img.shields.io/pypi/djversions/django-ninja-extra.svg)](https://pypi.python.org/pypi/django-ninja-extra)
-[![Codecov](https://img.shields.io/codecov/c/gh/eadwinCode/django-ninja-extra)](https://codecov.io/gh/eadwinCode/django-ninja-extra)
-[![Downloads](https://pepy.tech/badge/django-ninja-extra/month)](https://pepy.tech/project/django-ninja-extra)
-
-# Django Ninja Extra
-
-**Django Ninja Extra** is a complete class-based fashion of building and setting up APIs at incredible speed with incredible performance.
-It utilizes [**Django Ninja**](https://django-ninja.rest-framework.com) core features without compromising speed.
-
-**Key features:**
-
-All **Django-Ninja** features :
-
-- **Easy**: Designed to be easy to use and intuitive.
-- **FAST execution**: Very high performance thanks to **<a href="https://pydantic-docs.helpmanual.io" target="_blank">Pydantic</a>** and **<a href="/async-support/">async support</a>**.
-- **Fast to code**: Type hints and automatic docs lets you focus only on business logic.
-- **Standards-based**: Based on the open standards for APIs: **OpenAPI** (previously known as Swagger) and **JSON Schema**.
-- **Django friendly**: (obviously) has good integration with the Django core and ORM.
-
-Plus **Extra**:
-
-- **Class Based**: Design your APIs in a class based fashion.
-- **Permissions**: Protect endpoint(s) at ease with defined permissions and authorizations at route level or controller level.
-- **Dependency Injection**: Controller classes supports dependency injection with python [**Injector** ](https://injector.readthedocs.io/en/latest/) or [**django_injector**](https://github.com/blubber/django_injector). Giving you the ability to inject API dependable services to APIController class and utilizing them where needed
-
----
-
-### Requirements
-- Python >= 3.6
-- django >= 2.1 
-- pydantic >= 1.6 
-- Django-Ninja >= 0.16.1
-
-## Django-Ninja Benchmark
-**Django-Ninja-Extra** uses **Django-Ninja** under the hood, it can be assumed that Django-Ninja-Extra has the same benchmark with Django-Ninja
-![Django Ninja REST Framework](images/benchmark.png)
-
-Full documentation, [visit](https://eadwincode.github.io/django-ninja-extra/).
-
-## Sample Project
-Django-Ninja-Tutorial Project, [visit](https://github.com/eadwinCode/bookstoreapi)
-
-## Installation
-
-```
-pip install django-ninja-extra
-```
-After installation, add `ninja_extra` to your `INSTALLED_APPS`
-
-```Python 
-INSTALLED_APPS = [
-    ...,
-    'ninja_extra',
-]
-```
-
-## Usage
-
-In your django project next to urls.py create new `api.py` file:
-
-```Python
-from ninja_extra import NinjaExtraAPI, api_controller, http_get
-
-api = NinjaExtraAPI()
-
-# function based definition
-@api.get("/add", tags=['Math'])
-def add(request, a: int, b: int):
-    return {"result": a + b}
-
-#class based definition
-@api_controller('/', tags=['Math'], permissions=[])
-class MathAPI:
-
-    @http_get('/subtract',)
-    def subtract(self, a: int, b: int):
-        """Subtracts a from b"""
-        return {"result": a - b}
-
-    @http_get('/divide',)
-    def divide(self, a: int, b: int):
-        """Divides a by b"""
-        return {"result": a / b}
-    
-    @http_get('/multiple',)
-    def multiple(self, a: int, b: int):
-        """Multiples a with b"""
-        return {"result": a * b}
-    
-api.register_controllers(
-    MathAPI
-)
-```
-
-Now go to `urls.py` and add the following:
-
-```Python
-...
-from django.urls import path
-from .api import api
-
-urlpatterns = [
-    path("admin/", admin.site.urls),
-    path("api/", api.urls),  # <---------- !
-]
-```
-
-### Interactive API docs
-
-Now go to <a href="http://127.0.0.1:8000/api/docs" target="_blank">http://127.0.0.1:8000/api/docs</a>
-
-You will see the automatic interactive API documentation (provided by <a href="https://github.com/swagger-api/swagger-ui" target="_blank">Swagger UI</a>):
-
-![Swagger UI](images/ui_swagger_preview_readme.gif)
-## What next?
-- To support this project, please give star it on Github
-- API Throttling
+![Test](https://github.com/eadwinCode/django-ninja-extra/workflows/Test/badge.svg)
+[![PyPI version](https://badge.fury.io/py/django-ninja-extra.svg)](https://badge.fury.io/py/django-ninja-extra)
+[![PyPI version](https://img.shields.io/pypi/v/django-ninja-extra.svg)](https://pypi.python.org/pypi/django-ninja-extra)
+[![PyPI version](https://img.shields.io/pypi/pyversions/django-ninja-extra.svg)](https://pypi.python.org/pypi/django-ninja-extra)
+[![PyPI version](https://img.shields.io/pypi/djversions/django-ninja-extra.svg)](https://pypi.python.org/pypi/django-ninja-extra)
+[![Codecov](https://img.shields.io/codecov/c/gh/eadwinCode/django-ninja-extra)](https://codecov.io/gh/eadwinCode/django-ninja-extra)
+[![Downloads](https://pepy.tech/badge/django-ninja-extra/month)](https://pepy.tech/project/django-ninja-extra)
+
+# Django Ninja Extra
+
+**Django Ninja Extra** is a complete class-based fashion of building and setting up APIs at incredible speed with incredible performance.
+It utilizes [**Django Ninja**](https://django-ninja.rest-framework.com) core features without compromising speed.
+
+**Key features:**
+
+All **Django-Ninja** features :
+
+- **Easy**: Designed to be easy to use and intuitive.
+- **FAST execution**: Very high performance thanks to **<a href="https://pydantic-docs.helpmanual.io" target="_blank">Pydantic</a>** and **<a href="/async-support/">async support</a>**.
+- **Fast to code**: Type hints and automatic docs lets you focus only on business logic.
+- **Standards-based**: Based on the open standards for APIs: **OpenAPI** (previously known as Swagger) and **JSON Schema**.
+- **Django friendly**: (obviously) has good integration with the Django core and ORM.
+
+Plus **Extra**:
+
+- **Class Based**: Design your APIs in a class based fashion.
+- **Permissions**: Protect endpoint(s) at ease with defined permissions and authorizations at route level or controller level.
+- **Dependency Injection**: Controller classes supports dependency injection with python [**Injector** ](https://injector.readthedocs.io/en/latest/) or [**django_injector**](https://github.com/blubber/django_injector). Giving you the ability to inject API dependable services to APIController class and utilizing them where needed
+
+---
+
+### Requirements
+- Python >= 3.6
+- django >= 2.1 
+- pydantic >= 1.6 
+- Django-Ninja >= 0.16.1
+
+## Django-Ninja Benchmark
+**Django-Ninja-Extra** uses **Django-Ninja** under the hood, it can be assumed that Django-Ninja-Extra has the same benchmark with Django-Ninja
+![Django Ninja REST Framework](images/benchmark.png)
+
+Full documentation, [visit](https://eadwincode.github.io/django-ninja-extra/).
+
+## Sample Project
+Django-Ninja-Tutorial Project, [visit](https://github.com/eadwinCode/bookstoreapi)
+
+## Installation
+
+```
+pip install django-ninja-extra
+```
+After installation, add `ninja_extra` to your `INSTALLED_APPS`
+
+```Python 
+INSTALLED_APPS = [
+    ...,
+    'ninja_extra',
+]
+```
+
+## Usage
+
+In your django project next to urls.py create new `api.py` file:
+
+```Python
+from ninja_extra import NinjaExtraAPI, api_controller, http_get
+
+api = NinjaExtraAPI()
+
+# function based definition
+@api.get("/add", tags=['Math'])
+def add(request, a: int, b: int):
+    return {"result": a + b}
+
+#class based definition
+@api_controller('/', tags=['Math'], permissions=[])
+class MathAPI:
+
+    @http_get('/subtract',)
+    def subtract(self, a: int, b: int):
+        """Subtracts a from b"""
+        return {"result": a - b}
+
+    @http_get('/divide',)
+    def divide(self, a: int, b: int):
+        """Divides a by b"""
+        return {"result": a / b}
+    
+    @http_get('/multiple',)
+    def multiple(self, a: int, b: int):
+        """Multiples a with b"""
+        return {"result": a * b}
+    
+api.register_controllers(
+    MathAPI
+)
+```
+
+Now go to `urls.py` and add the following:
+
+```Python
+...
+from django.urls import path
+from .api import api
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+    path("api/", api.urls),  # <---------- !
+]
+```
+
+### Interactive API docs
+
+Now go to <a href="http://127.0.0.1:8000/api/docs" target="_blank">http://127.0.0.1:8000/api/docs</a>
+
+You will see the automatic interactive API documentation (provided by <a href="https://github.com/swagger-api/swagger-ui" target="_blank">Swagger UI</a>):
+
+![Swagger UI](images/ui_swagger_preview_readme.gif)
+## What next?
+- To support this project, please give star it on Github
+- API Throttling