Merge pull request #20 from python-ellar/proj_info_update

Project PyPI info updates

Author: eadwinCode

.github/workflows/publish.yml

@@ -17,9 +17,12 @@ jobs:
       - name: Install Flit
         run: pip install flit
       - name: Install Dependencies
-        run: flit install --symlink
+        run: make install
+      - name: Install build dependencies
+        run: pip install build
+      - name: Build distribution
+        run: python -m build
       - name: Publish
-        env:
-          FLIT_USERNAME: ${{ secrets.FLIT_USERNAME }}
-          FLIT_PASSWORD: ${{ secrets.FLIT_PASSWORD }}
-        run: flit publish
+        uses: pypa/[email protected]
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test.yml

@@ -14,11 +14,11 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: "3.10"
       - name: Install Flit
         run: pip install flit
       - name: Install Dependencies
-        run: flit install --symlink
+        run: make install
       - name: Test
         run: make test-cov
       - name: Coverage

.github/workflows/test_full.yml

@@ -10,8 +10,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
-        django-version: ['<3.0', '<3.1', '<3.2', '<3.3', '<4.1', '<4.2']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        django-version: ['<3.2', '<3.3', '<4.2', '<4.3']
+        exclude:
+          - python-version: '3.12'
+            django-version: '<3.2'
+          - python-version: '3.12'
+            django-version: '<3.3'
 
     steps:
       - uses: actions/checkout@v4
@@ -24,7 +29,7 @@ jobs:
       - name: Install Flit
         run: pip install flit
       - name: Install Dependencies
-        run: flit install --symlink
+        run: make install
       - name: Test
         run: pytest tests
 
@@ -39,9 +44,7 @@ jobs:
       - name: Install Flit
         run: pip install flit
       - name: Install Dependencies
-        run: flit install --symlink
-      - name: Black
-        run: black --check ellar_django tests
+        run: make install
       - name: Ruff Linting Check
         run: ruff check ellar_django tests
       - name: mypy

Makefile

@@ -11,19 +11,19 @@ clean: ## Removing cached python compiled files
 	find . -name __pycache__  | xargs  rm -rfv
 
 install: ## Install dependencies
-	flit install --deps develop --symlink
+	pip install -r requirements.txt
+	flit install --symlink
 
 install-full: ## Install dependencies
 	make install
 	pre-commit install -f
 
 lint: ## Run code linters
-	black --check ellar_django tests
 	ruff check ellar_django tests
 	mypy ellar_django
 
 fmt format: ## Run code formatters
-	black ellar_django tests
+	ruff format ellar_django tests
 	ruff check --fix ellar_django tests
 
 test: ## Run tests

README.md

@@ -205,6 +205,7 @@ MIDDLEWARE = [
     "whitenoise.middleware.WhiteNoiseMiddleware",
     ...
 ]
+WHITENOISE_STATIC_PREFIX = '/static/'
 ...
 ```
 So when you visit [http://localhost:8000/-django-example/admin](http://localhost:8000/-django-example/admin) again, the page should be functional.

ellar_django/commands.py

@@ -1,26 +1,156 @@
 import sys
+import typing as t
 
-from ellar.common.commands import command
+import django
+import ellar_cli.click as click
 
-HELP_MESSAGE = """
-Ellar will always intercept and command with '--help'.
 
-So if you want to get help on any django command,
-simply wrap the command and --help in quotes
+class _CommandItem(t.NamedTuple):
+    name: str
+    description: str
 
-For example: ellar django 'migrate --help'
-"""
 
+_django_support_commands: t.List[_CommandItem] = [
+    _CommandItem(
+        name="migrate",
+        description="Synchronizes the database state with the current set of models and migrations",
+    ),
+    _CommandItem(
+        name="makemigrations",
+        description="Creates new migrations based on the changes detected to your models.",
+    ),
+    _CommandItem(
+        name="check",
+        description="inspects the entire Django project for common problems",
+    ),
+    _CommandItem(
+        name="createcachetable",
+        description="Creates the cache tables for use with the database cache backend",
+    ),
+    _CommandItem(
+        name="dbshell",
+        description="Runs the command-line client for the database engine",
+    ),
+    _CommandItem(
+        name="diffsettings",
+        description="Displays differences between the current settings and default settings",
+    ),
+    _CommandItem(
+        name="dumpdata",
+        description="Outputs to standard output all data in the database",
+    ),
+    _CommandItem(
+        name="flush",
+        description="Removes all data from the database and re-executes any post-synchronization handlers",
+    ),
+    _CommandItem(
+        name="inspectdb", description="Introspects the database tables in the database"
+    ),
+    _CommandItem(
+        name="loaddata",
+        description="Searches for and loads the contents into the database.",
+    ),
+    _CommandItem(
+        name="optimizemigration",
+        description="Optimizes the operations for the named migration and overrides the existing file",
+    ),
+    _CommandItem(
+        name="showmigrations", description="Shows all migrations in a project."
+    ),
+    _CommandItem(
+        name="sqlflush",
+        description="Prints the SQL statements that would be executed for the flush command",
+    ),
+    _CommandItem(
+        name="sqlmigrate", description="Prints the SQL for the named migration."
+    ),
+    _CommandItem(
+        name="sqlsequencereset",
+        description="Prints the SQL statements for resetting sequences for the given app name(s)",
+    ),
+    _CommandItem(
+        name="squashmigrations", description="Squashes the migrations for app_label"
+    ),
+    _CommandItem(
+        name="startapp", description="Creates a Django app directory structure"
+    ),
+    _CommandItem(
+        name="changepassword",
+        description="This command is only available if Django’s authentication system",
+    ),
+    _CommandItem(
+        name="createsuperuser",
+        description="Creates a superuser account (a user who has all permissions)",
+    ),
+    _CommandItem(
+        name="collectstatic", description="Expose static files to STATIC_ROOT folder"
+    ),
+    _CommandItem(name="findstatic", description="Search for a static file location"),
+    _CommandItem(
+        name="clearsessions",
+        description="Can be run as a cron job or directly to clean out expired sessions.",
+    ),
+]
 
-@command(
+
+def version_callback(ctx: click.Context, _: t.Any, value: bool) -> None:
+    if value:
+        click.echo(f"Django Version: {django.__version__}")
+        raise click.Exit(0)
+
+
+@click.group(
     name="django",
-    context_settings={"ignore_unknown_options": True, "allow_extra_args": True},
-    help=HELP_MESSAGE,
+    help="- Ellar Django Commands",
 )
-def django_command_wrapper() -> None:
-    from django.core.management import execute_from_command_line
+@click.option(
+    "-v",
+    "--version",
+    callback=version_callback,
+    help="Show the version and exit.",
+    is_flag=True,
+    expose_value=False,
+    is_eager=True,
+)
+@click.pass_context
+def django_command(ctx: click.Context) -> None:
+    pass
+
+
+def _add_django_command(command_item: _CommandItem) -> None:
+    def help_callback(ctx: click.Context, _: t.Any, value: bool) -> None:
+        from django.core.management import execute_from_command_line
+
+        if value:
+            args = ["manage.py", command_item.name, "--help"]
+
+            execute_from_command_line(args)
+            raise click.Exit(0)
+
+    @django_command.command(
+        name=command_item.name,
+        help=command_item.description,
+        context_settings={"ignore_unknown_options": True, "allow_extra_args": True},
+        add_help_option=False,
+    )
+    @click.option(
+        "-h",
+        "--help",
+        callback=help_callback,
+        help="Show the version and exit.",
+        is_flag=True,
+        expose_value=False,
+        is_eager=True,
+    )
+    @click.with_app_context
+    def _command() -> None:
+        from django.core.management import execute_from_command_line
+
+        args = ["manage.py", command_item.name]
+
+        for item in sys.argv[3:]:
+            args.extend(item.split(" "))
+        execute_from_command_line(args)
+
 
-    args = []
-    for item in sys.argv[1:]:
-        args.extend(item.split(" "))
-    execute_from_command_line(args)
+list(map(_add_django_command, _django_support_commands))

ellar_django/middleware.py

@@ -0,0 +1,34 @@
+import typing as t
+
+from ellar.common.types import ASGIApp, TMessage, TReceive, TScope, TSend
+from starlette.datastructures import MutableHeaders
+
+
+class DjangoAdminRedirectMiddleware:
+    def __init__(self, app: ASGIApp, path_prefix: str) -> None:
+        self.app = app
+        self.path_prefix = path_prefix
+
+    async def __call__(self, scope: TScope, receive: TReceive, send: TSend) -> t.Any:
+        if scope["type"] != "http":  # pragma: no cover
+            return await self.app(scope, receive, send)
+
+        async def sender(message: TMessage) -> None:
+            if message["type"] == "http.response.start":
+                headers = message.get("headers")
+                if headers:
+                    working_headers = MutableHeaders(
+                        raw=[
+                            (key.decode("latin-1").lower().encode("latin-1"), value)
+                            for key, value in headers
+                        ]
+                    )
+                    location = working_headers.get("location")
+                    if location and not location.startswith(self.path_prefix):
+                        working_headers["Location"] = (
+                            f"{self.path_prefix}{working_headers['Location']}"
+                        )
+                        message["headers"] = working_headers.raw
+            await send(message)
+
+        return await self.app(scope, receive, sender)

ellar_django/module.py

@@ -2,12 +2,13 @@
 
 from django.core.asgi import get_asgi_application
 from ellar.common import IModuleSetup, Module, ModuleRouter
-from ellar.common.routing import Mount
 from ellar.core import DynamicModule, Request
-from ellar.core.routing import ModuleRouterFactory
+from ellar.core.router_builders import ModuleRouterBuilder
 from starlette.responses import RedirectResponse
+from starlette.routing import Mount
 
-from .commands import django_command_wrapper
+from .commands import django_command
+from .middleware import DjangoAdminRedirectMiddleware
 
 _router = ModuleRouter()
 
@@ -17,14 +18,28 @@ async def _redirect_route(req: Request) -> RedirectResponse:
     return RedirectResponse(url=str(req.base_url))
 
 
-@Module(commands=[django_command_wrapper])
+@Module(commands=[django_command])
 class DjangoModule(IModuleSetup):
     @classmethod
     def setup(cls, settings_module: str, path_prefix: str = "/dj") -> "DynamicModule":
+        assert path_prefix not in [
+            "",
+            "/",
+        ], "Invalid path prefix, please set a valid path prefix"
+
         os.environ.setdefault("DJANGO_SETTINGS_MODULE", settings_module)
-        ModuleRouterFactory.build(_router)
+        _router_as_mount = ModuleRouterBuilder.build(_router)
 
         mount = Mount(
-            path_prefix, routes=[_router, Mount("/", app=get_asgi_application())]
+            path_prefix,
+            routes=[
+                _router_as_mount,
+                Mount(
+                    "/",
+                    app=DjangoAdminRedirectMiddleware(
+                        get_asgi_application(), path_prefix
+                    ),
+                ),
+            ],
         )
         return DynamicModule(cls, routers=[mount])