lint: setting name changes

Author: freemindcore

README.md

@@ -83,10 +83,10 @@ You will see the automatic interactive API documentation (provided by Swagger UI
 ![Auto generated APIs List](https://github.com/freemindcore/django-api-framework/blob/fae8209a8d08c55daf75ac3a4619fe62b8ef3af6/docs/images/admin_apis_list.png)
 
 #### Configuration
-If `AUTO_ADMIN_ENABLED_ALL_APPS` is set to True (default), all app models CRUD apis will be generated.
-Apps in the `AUTO_ADMIN_EXCLUDE_APPS` list, will be always excluded.
+If `CRUD_API_ENABLED_ALL_APPS` is set to True (default), all app models CRUD apis will be generated.
+Apps in the `CRUD_API_EXCLUDE_APPS` list, will be always excluded.
 
-If `AUTO_ADMIN_ENABLED_ALL_APPS` is set to False, only apps in the `AUTO_ADMIN_INCLUDE_APPS` list will have CRUD apis generated.
+If `CRUD_API_ENABLED_ALL_APPS` is set to False, only apps in the `CRUD_API_INCLUDE_APPS` list will have CRUD apis generated.
 
 Also, configuration is possible for each model, via ApiMeta class:
 - `generate_crud`:      whether to create crud api, default to True

easy/conf/settings.py

@@ -5,13 +5,11 @@
 
 # AUTO ADMIN API settings
 # If not all
-AUTO_ADMIN_ENABLED_ALL_APPS = getattr(
-    django_settings, "AUTO_ADMIN_ENABLED_ALL_APPS", True
-)
+CRUD_API_ENABLED_ALL_APPS = getattr(django_settings, "CRUD_API_ENABLED_ALL_APPS", True)
 # Only generate for included apps
-AUTO_ADMIN_INCLUDE_APPS = getattr(django_settings, "AUTO_ADMIN_INCLUDE_APPS", [])
+CRUD_API_INCLUDE_APPS = getattr(django_settings, "CRUD_API_INCLUDE_APPS", [])
 # Exclude apps always got excluded
-AUTO_ADMIN_EXCLUDE_APPS = getattr(django_settings, "AUTO_ADMIN_EXCLUDE_APPS", [])
+CRUD_API_EXCLUDE_APPS = getattr(django_settings, "CRUD_API_EXCLUDE_APPS", [])
 
 
 def reload_settings(*args: Any, **kwargs: Any) -> None:  # pragma: no cover

easy/main.py

@@ -5,14 +5,14 @@
 from django.conf import settings
 from django.http import HttpRequest, HttpResponse
 from django.utils.module_loading import module_has_submodule
-from domain.orm import django_serializer
 from ninja.constants import NOT_SET, NOT_SET_TYPE
 from ninja.parser import Parser
 from ninja.renderers import BaseRenderer
 from ninja.types import TCallable
 from ninja_extra import NinjaExtraAPI
 
 from easy.controller.auto_api import create_admin_controller
+from easy.domain.orm import django_serializer
 from easy.renderer.json import EasyJSONRenderer
 from easy.response import BaseApiResponse
 
@@ -29,9 +29,9 @@ class EasyAPI(NinjaExtraAPI):
             If True, will be encapsulated in BaseAPIResponse
     -renderer, default to EasyJSONRenderer
     -Auto generate AdminAPIs, it will read the following settings:
-        AUTO_ADMIN_ENABLED_ALL_APPS
-        AUTO_ADMIN_EXCLUDE_APPS
-        AUTO_ADMIN_INCLUDE_APPS
+        CRUD_API_ENABLED_ALL_APPS
+        CRUD_API_EXCLUDE_APPS
+        CRUD_API_INCLUDE_APPS
     """
 
     def __init__(
@@ -75,17 +75,17 @@ def __init__(
     def auto_create_admin_controllers(self, version: str = None) -> None:
         for app_module in self.get_installed_apps():
             # If not all
-            if not settings.AUTO_ADMIN_ENABLED_ALL_APPS:  # type:ignore
+            if not settings.CRUD_API_ENABLED_ALL_APPS:  # type:ignore
                 # Only generate for this included apps
-                if settings.AUTO_ADMIN_INCLUDE_APPS is not None:  # type:ignore
+                if settings.CRUD_API_INCLUDE_APPS is not None:  # type:ignore
                     if (
                         app_module.name
-                        not in settings.AUTO_ADMIN_INCLUDE_APPS  # type:ignore
+                        not in settings.CRUD_API_INCLUDE_APPS  # type:ignore
                     ):
                         continue
 
             # Exclude list
-            if app_module.name in settings.AUTO_ADMIN_EXCLUDE_APPS:  # type:ignore
+            if app_module.name in settings.CRUD_API_EXCLUDE_APPS:  # type:ignore
                 continue
 
             try:

tests/config/settings.py

@@ -3,9 +3,9 @@
 """
 
 # Admin API auto-generation settings
-AUTO_ADMIN_ENABLED_ALL_APPS = True
-AUTO_ADMIN_INCLUDE_APPS = []
-AUTO_ADMIN_EXCLUDE_APPS = []
+CRUD_API_ENABLED_ALL_APPS = True
+CRUD_API_INCLUDE_APPS = []
+CRUD_API_EXCLUDE_APPS = []
 
 # Django Settings
 INSTALLED_APPS = (

tests/test_auto_api_creation.py

@@ -66,14 +66,14 @@ async def test_auto_apis(transactional_db, user, easy_api_client):
 
 
 async def test_auto_generation_settings(settings):
-    settings.AUTO_ADMIN_EXCLUDE_APPS = ["tests.easy_app"]
+    settings.CRUD_API_EXCLUDE_APPS = ["tests.easy_app"]
     api_admin_v2 = EasyAPI()
     api_admin_v2.auto_create_admin_controllers()
     assert len(api_admin_v2._routers) == 1
 
-    settings.AUTO_ADMIN_ENABLED_ALL_APPS = False
-    settings.AUTO_ADMIN_EXCLUDE_APPS = []
-    settings.AUTO_ADMIN_INCLUDE_APPS = ["tests.none_existing_app"]
+    settings.CRUD_API_ENABLED_ALL_APPS = False
+    settings.CRUD_API_EXCLUDE_APPS = []
+    settings.CRUD_API_INCLUDE_APPS = ["tests.none_existing_app"]
     api_admin_v3 = EasyAPI()
     api_admin_v3.auto_create_admin_controllers()
     assert len(api_admin_v3._routers) == 1

tests/test_settings.py

@@ -1,11 +1,11 @@
 from easy.conf.settings import (
-    AUTO_ADMIN_ENABLED_ALL_APPS,
-    AUTO_ADMIN_EXCLUDE_APPS,
-    AUTO_ADMIN_INCLUDE_APPS,
+    CRUD_API_ENABLED_ALL_APPS,
+    CRUD_API_EXCLUDE_APPS,
+    CRUD_API_INCLUDE_APPS,
 )
 
 
 def test_change_django_settings(settings):
-    assert settings.AUTO_ADMIN_ENABLED_ALL_APPS == AUTO_ADMIN_ENABLED_ALL_APPS
-    assert settings.AUTO_ADMIN_INCLUDE_APPS == AUTO_ADMIN_INCLUDE_APPS
-    assert settings.AUTO_ADMIN_EXCLUDE_APPS == AUTO_ADMIN_EXCLUDE_APPS
+    assert settings.CRUD_API_ENABLED_ALL_APPS == CRUD_API_ENABLED_ALL_APPS
+    assert settings.CRUD_API_INCLUDE_APPS == CRUD_API_INCLUDE_APPS
+    assert settings.CRUD_API_EXCLUDE_APPS == CRUD_API_EXCLUDE_APPS