djangx 0.1.0.dev2__tar.gz → 0.1.0.dev3__tar.gz

djangx-0.1.0.dev3/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.4
+Name: djangX
+Version: 0.1.0.dev3
+Summary: 
+Author: Kevin Wakhisi
+Author-email: Kevin Wakhisi <kevin@treeolive.tech>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: django>=6.1.2
+Requires-Dist: pillow>=13.0.0
+Requires-Dist: python-dotenv>=1.2.4
+Requires-Dist: psycopg[binary,pool]>=3.3.6 ; extra == 'postgres'
+Requires-Dist: psycopg[binary,pool]>=3.3.6 ; extra == 'vercel'
+Requires-Dist: vercel>=0.12.0 ; extra == 'vercel'
+Requires-Python: >=3.14
+Project-URL: repository, https://github.com/treeolive-tech/djangX.git
+Provides-Extra: postgres
+Provides-Extra: vercel
+Description-Content-Type: text/markdown
+
+# djangX

djangx-0.1.0.dev3/README.md

@@ -0,0 +1 @@
+# djangX

djangx-0.1.0.dev3/pyproject.toml

@@ -0,0 +1,92 @@
+[project]
+name = "djangX"
+version = "0.1.0.dev3"
+description = ""
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.14"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "django>=6.1.2",
+    "pillow>=13.0.0",
+    "python-dotenv>=1.2.4",
+]
+
+[project.urls]
+repository = "https://github.com/treeolive-tech/djangX.git"
+
+[[project.authors]]
+name = "Kevin Wakhisi"
+email = "kevin@treeolive.tech"
+
+[project.optional-dependencies]
+postgres = ["psycopg[binary,pool]>=3.3.6"]
+vercel = [
+    "psycopg[binary,pool]>=3.3.6",
+    "vercel>=0.12.0",
+]
+
+[project.scripts]
+djangx = "djangx.core.management:main"
+djx = "djangx.core.management:main"
+
+[dependency-groups]
+dev = [
+    "django-browser-reload>=1.21.0",
+    "django-http-compression[brotli]>=1.4.0",
+    "django-minify-html>=1.14.0",
+    "django-stubs>=6.1.2",
+    "djlint>=1.47.0",
+    "poethepoet>=0.49.0",
+    "psycopg[binary,pool]>=3.3.6",
+    "vercel>=0.12.0",
+    "djangorestframework>=3.18.3",
+    "django-filter>=26.2",
+    "markdown>=3.11.2",
+]
+
+[build-system]
+requires = ["uv_build>=0.13.4,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv]
+preview-features = [
+    "format-command",
+    "check-command",
+]
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true
+
+[[tool.poe.tasks.format.sequence]]
+cmd = "uv format"
+
+[[tool.poe.tasks.lint.sequence]]
+cmd = "uv format --check"
+
+[[tool.poe.tasks.lint.sequence]]
+cmd = "uv lock --check"
+
+[[tool.poe.tasks.lint.sequence]]
+cmd = "uv check"
+
+[tool.djlint]
+format_css = true
+format_js = true
+custom_blocks = "body,aside,header,footer,main,section,list"
+blank_line_before_tag = "block,list"
+blank_line_after_tag = "endblock,endlist"
+ignore = "H016,H030,H031"
+
+[tool.ruff]
+exclude = ["*/migrations/*"]

djangx-0.1.0.dev3/pyproject.toml.orig

@@ -0,0 +1,79 @@
+[project.urls]
+repository = "https://github.com/treeolive-tech/djangX.git"
+
+[project]
+name = "djangX"
+version = "0.1.0.dev3"
+description = ""
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Kevin Wakhisi", email = "kevin@treeolive.tech" }]
+requires-python = ">=3.14"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = ["django>=6.1.2", "pillow>=13.0.0", "python-dotenv>=1.2.4"]
+
+[project.optional-dependencies]
+postgres = ["psycopg[binary,pool]>=3.3.6"]
+vercel = ["psycopg[binary,pool]>=3.3.6", "vercel>=0.12.0"]
+
+[dependency-groups]
+dev = [
+    "django-browser-reload>=1.21.0",
+    "django-http-compression[brotli]>=1.4.0",
+    "django-minify-html>=1.14.0",
+    "django-stubs>=6.1.2",
+    "djlint>=1.47.0",
+    "poethepoet>=0.49.0",
+    "psycopg[binary,pool]>=3.3.6",
+    "vercel>=0.12.0",
+
+    # rest framework
+    "djangorestframework>=3.18.3",
+    "django-filter>=26.2",
+    "markdown>=3.11.2",
+]
+
+[project.scripts]
+djangx = "djangx.core.management:main"
+djx = "djangx.core.management:main"
+
+[build-system]
+requires = ["uv_build>=0.13.4,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv]
+preview-features = ["format-command", "check-command"]
+
+[tool.poe.tasks.format]
+sequence = [{ cmd = "uv format" }]
+
+[tool.poe.tasks.lint]
+sequence = [
+    { cmd = "uv format --check" },
+    { cmd = "uv lock --check" },
+    { cmd = "uv check" },
+]
+
+[tool.djlint]
+format_css = true
+format_js = true
+custom_blocks = "body,aside,header,footer,main,section,list"
+blank_line_before_tag = "block,list"
+blank_line_after_tag = "endblock,endlist"
+ignore = "H016,H030,H031"
+
+[tool.ruff]
+exclude = ["*/migrations/*"]
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true

djangx-0.1.0.dev3/src/djangx/__init__.py

@@ -0,0 +1,9 @@
+from pathlib import Path
+from typing import Final
+
+
+class Package:
+    name: Final[str] = Path(__file__).resolve().parent.name  # djangx
+    verbose_name: Final[str] = name[:-1] + name[-1].upper()  # djangX
+    core: Final[str] = f"{name}.core"
+    components: Final[str] = f"{name}.components"

djangx-0.1.0.dev3/src/djangx/core/__init__.py

@@ -0,0 +1,27 @@
+from pathlib import Path
+from sys import argv
+
+from .. import Package
+from .utils import ExitCode, PyProject
+
+DJANGO_SETTINGS_MODULE: str | None = PyProject(Path.cwd() / "pyproject.toml").settings
+
+
+def print_help_message() -> None:
+    """Print built-in help, or an error and exit if the command is unknown."""
+    from .management.commands import HELP_COMMANDS
+
+    match argv[1]:
+        case cmd if cmd in HELP_COMMANDS:
+            print(
+                f"No pyproject.toml found (or it's missing [tool.{Package.name}] `settings` key), "
+                "so only built-in commands are shown below.\n\n"
+                "To see project-specific commands, run this from the root of a "
+                f"{Package.verbose_name} project, or add to your pyproject.toml:\n\n"
+                f"    [tool.{Package.name}]\n"
+                '    settings = "app.settings"'
+            )
+
+        case _:
+            print(f"Unknown command: '{cmd}'\nType '{Package.name} help' for usage.")
+            raise SystemExit(ExitCode.ERROR)

djangx-0.1.0.dev3/src/djangx/core/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+from .. import Package
+
+
+class CoreConfig(AppConfig):
+    name = Package.core

djangx-0.1.0.dev3/src/djangx/core/asgi.py

@@ -0,0 +1,22 @@
+"""
+ASGI config.
+
+It exposes the ASGI callable as a module-level variable named ``app``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/6.0/howto/deployment/asgi/
+"""
+
+from . import DJANGO_SETTINGS_MODULE
+
+if DJANGO_SETTINGS_MODULE is None:
+    from . import print_help_message
+
+    print_help_message()
+else:
+    from os import environ
+
+    from django.core.asgi import get_asgi_application
+
+    environ.setdefault("DJANGO_SETTINGS_MODULE", DJANGO_SETTINGS_MODULE)
+    application = get_asgi_application()

djangx-0.1.0.dev3/src/djangx/core/management/__init__.py

@@ -0,0 +1,81 @@
+"""Command-line entry point."""
+
+from sys import argv
+
+from .commands import BUILTIN_COMMANDS, HELP_COMMANDS
+
+
+def _run_builtin() -> None:
+    """Run a built-in command with a minimal Django setup and no Django core commands."""
+    from django import setup
+    from django.conf import settings
+    from django.core.management import execute_from_command_line, get_commands
+
+    from ..apps import CoreConfig
+
+    if not settings.configured:
+        settings.configure(INSTALLED_APPS=[CoreConfig.name])
+        setup()
+
+    commands = get_commands()
+    for name, app in list(commands.items()):
+        if app == "django.core":
+            del commands[name]
+
+    execute_from_command_line(argv)
+
+
+def _run_project_or_help(command: str) -> None:
+    """Run a command against the project's settings, or show help if none is found."""
+
+    from .. import DJANGO_SETTINGS_MODULE, print_help_message
+
+    if DJANGO_SETTINGS_MODULE:
+        from os import environ
+        from pathlib import Path
+        from sys import path
+
+        from django.core.management import execute_from_command_line
+        from dotenv import load_dotenv
+
+        base_dir = Path.cwd()
+        path.insert(0, str(base_dir))
+        environ.setdefault("DJANGO_SETTINGS_MODULE", DJANGO_SETTINGS_MODULE)
+        dotenv = base_dir / ".env.local"
+
+        if dotenv.is_file():
+            load_dotenv(dotenv)
+
+        execute_from_command_line(argv)
+        return
+
+    print_help_message()
+    if command in HELP_COMMANDS:
+        _run_builtin()
+
+
+def main() -> None:
+    """Dispatch the CLI command."""
+    command: str | None = argv[1] if len(argv) > 1 else None
+
+    match command:
+        case None:
+            print(
+                "...but the people who know their God shall be strong and do exploits. — Daniel 11:32"
+            )
+
+        case "-v" | "--version" | "version":
+            from ... import Package
+            from ..utils import print_version
+
+            raise SystemExit(print_version(Package.name))
+
+        case _ if command in BUILTIN_COMMANDS:
+            _run_builtin()
+
+        case _:
+            _run_project_or_help(command)
+
+
+if __name__ == "__main__":
+    main()

djangx-0.1.0.dev3/src/djangx/core/management/commands/__init__.py

@@ -0,0 +1,9 @@
+from pathlib import Path
+
+BUILTIN_COMMANDS: set[str] = {
+    path.stem
+    for path in Path(__file__).resolve().parent.glob("*.py")
+    if path.name != "__init__.py"
+}
+
+HELP_COMMANDS: set[str] = {"help", "-h"}

djangx-0.1.0.dev3/src/djangx/core/utils/__init__.py

@@ -0,0 +1,4 @@
+from .enum import *
+from .platform import *
+from .pyproject import *
+from .version import *

djangx-0.1.0.dev3/src/djangx/core/utils/enum.py

@@ -0,0 +1,16 @@
+from enum import IntEnum
+
+__all__: list[str] = ["ExitCode"]
+
+
+class ExitCode(IntEnum):
+    """Standard process exit codes following Unix conventions.
+
+    Examples::
+
+        raise SystemExit(ExitCode.ERROR)   # exits with code 1
+        raise SystemExit(ExitCode.SUCCESS) # exits with code 0
+    """
+
+    SUCCESS = 0  # Command completed without errors.
+    ERROR = 1  # Command encountered an error.

djangx-0.1.0.dev3/src/djangx/core/utils/platform.py

@@ -0,0 +1,79 @@
+"""Platform and architecture detection utilities."""
+
+from platform import machine, system
+from typing import Final
+
+__all__: list[str] = ["Platform"]
+
+
+class Platform:
+    """Detect the current OS and CPU architecture as normalised codes.
+
+    Raises:
+        OSError: If the OS is unsupported.
+        ValueError: If the CPU architecture is unsupported.
+
+    Examples::
+
+        p = Platform()
+        str(p)           # "macos-arm64"
+        p.os_name        # "macos"
+        p.architecture   # "arm64"
+    """
+
+    _PLATFORM_MAP: Final[dict[str, str]] = {
+        "darwin": "macos",
+        "linux": "linux",
+        "windows": "windows",
+        "android": "android",
+    }
+
+    _ARCH_MAP: Final[dict[str, str]] = {
+        "x86_64": "x64",
+        "amd64": "x64",
+        "x64": "x64",
+        "arm64": "arm64",
+        "aarch64": "arm64",
+        "armv8": "arm64",
+        "armv7l": "arm",
+        "armv7": "arm",
+        "armv6l": "arm",
+    }
+
+    def __init__(self) -> None:
+        """Detect the current OS and architecture and store them on the instance."""
+        self.os_name: str = self._detect_os()
+        self.architecture: str = self._detect_architecture()
+
+    def _detect_os(self) -> str:
+        """Normalise :func:`platform.system`, e.g. ``"Darwin"`` -> ``"macos"``."""
+        system_platform: str = system().lower()
+        platform_name: str | None = self._PLATFORM_MAP.get(system_platform)
+        if not platform_name:
+            supported: str = ", ".join(dict.fromkeys(self._PLATFORM_MAP.values()))
+            raise OSError(
+                f"Unsupported operating system: {system_platform}. Supported: {supported}"
+            )
+        return platform_name
+
+    def _detect_architecture(self) -> str:
+        """Normalise :func:`platform.machine`, e.g. ``"aarch64"`` -> ``"arm64"``."""
+        machine_platform: str = machine().lower()
+        architecture: str | None = self._ARCH_MAP.get(machine_platform)
+        if not architecture:
+            supported: str = ", ".join(dict.fromkeys(self._ARCH_MAP.values()))
+            raise ValueError(
+                f"Unsupported architecture: {machine_platform}. Supported: {supported}"
+            )
+        return architecture
+
+    def __str__(self) -> str:
+        """Return ``"<os_name>-<architecture>"``.
+
+        Examples::
+
+            str(Platform())    # "linux-x64"
+            f"{Platform()}"    # "macos-arm64"
+            print(Platform())  # windows-x64
+        """
+        return f"{self.os_name}-{self.architecture}"

djangx-0.1.0.dev3/src/djangx/core/utils/pyproject.py

@@ -0,0 +1,80 @@
+"""Read ``pyproject.toml`` data and the project's settings module."""
+
+from pathlib import Path
+from typing import Any
+
+from ... import Package
+
+__all__: list[str] = ["PyProject"]
+
+
+class PyProject:
+    """Read-only view of a parsed ``pyproject.toml`` file.
+
+    Args:
+        toml_path: Path to the ``pyproject.toml`` file.
+
+    Raises:
+        FileNotFoundError: If *toml_path* does not exist.
+        tomllib.TOMLDecodeError: If the file contains invalid TOML.
+
+    Examples::
+
+        p = PyProject(Path("pyproject.toml"))
+        p.name     # "my-project"
+        p.version  # "0.1.0"
+        p.data     # the full parsed dict
+    """
+
+    def __init__(self, toml_path: Path) -> None:
+        """Parse *toml_path* and store the result."""
+        from tomllib import load
+
+        self.path: Path = toml_path
+
+        with open(file=self.path, mode="rb") as f:
+            self._data: dict[str, Any] = load(f)
+
+    @property
+    def name(self) -> str:
+        """The ``[project] name`` value.
+
+        Raises:
+            KeyError: If ``[project]`` or ``name`` is missing.
+        """
+        return self._data["project"]["name"]
+
+    @property
+    def version(self) -> str:
+        """The ``[project] version`` value.
+
+        Raises:
+            KeyError: If ``[project]`` or ``version`` is missing.
+        """
+        return self._data["project"]["version"]
+
+    @property
+    def description(self) -> str | None:
+        """The ``[project] description`` value, or ``None`` if not set."""
+        return self._data["project"].get("description")
+
+    @property
+    def settings(self) -> str | None:
+        """The ``[tool.<package>] settings`` value, or ``None`` if missing or blank.
+
+        Examples::
+
+            # [tool.djangx]
+            # settings = "app.settings"
+            p.settings  # "app.settings"
+        """
+        try:
+            value: Any = self._data["tool"][Package.name]["settings"]
+            return value if isinstance(value, str) and value.strip() else None
+        except KeyError:
+            return None
+
+    @property
+    def data(self) -> dict[str, Any]:
+        """The full parsed TOML as a dict."""
+        return self._data

djangx-0.1.0.dev3/src/djangx/core/utils/version.py

@@ -0,0 +1,87 @@
+"""Version lookup utilities."""
+
+from typing import Literal, NamedTuple, final
+
+from .enum import ExitCode
+
+__all__: list[str] = ["Version", "VersionResult", "print_version"]
+
+
+class VersionResult(NamedTuple):
+    """A version string paired with an error message (empty on success).
+
+    Examples::
+
+        output, error = Version.get("django")
+        Version.get("django").output
+    """
+
+    output: str
+    error: str
+
+
+@final
+class Version:
+    """Namespace for looking up installed package versions.
+
+    Examples::
+
+        Version.get("django").output  # "5.1.0"
+    """
+
+    __slots__ = ()
+
+    def __new__(cls):
+        raise TypeError(f"{cls.__name__} cannot be instantiated.")
+
+    @staticmethod
+    def placeholder() -> Literal["X.Y.Z"]:
+        """Return the placeholder used when a version cannot be found.
+
+        Examples::
+
+            Version.placeholder()  # "X.Y.Z"
+        """
+        return "X.Y.Z"
+
+    @staticmethod
+    def get(package: str) -> VersionResult:
+        """Return the installed version of *package*, or a placeholder on failure.
+
+        Examples::
+
+            Version.get("django")             # VersionResult("5.1.0", "")
+            Version.get("not-installed-pkg")  # VersionResult("X.Y.Z", "Package ... not installed ...")
+        """
+        try:
+            from importlib.metadata import PackageNotFoundError, version
+
+            return VersionResult(version(distribution_name=package), error="")
+        except PackageNotFoundError:
+            return VersionResult(
+                output=Version.placeholder(),
+                error=f"Package '{package}' is not installed or could not be found.",
+            )
+        except Exception as e:  # noqa: BLE001 - must always return a VersionResult
+            return VersionResult(
+                output=Version.placeholder(),
+                error=f"Could not determine version for '{package}': {type(e).__name__}: {e}",
+            )
+
+
+def print_version(package: str) -> ExitCode:
+    """Print the installed version of *package* and return an exit code.
+
+    Examples::
+
+        print_version("django")  # prints "5.1.0", returns ExitCode.SUCCESS
+        print_version("nope")    # prints an error, returns ExitCode.ERROR
+    """
+    result: VersionResult = Version.get(package)
+
+    if result.error:
+        print(f"Could not determine version for package '{package}'.\n{result.error}")
+        return ExitCode.ERROR
+    else:
+        print(result.output)
+        return ExitCode.SUCCESS

djangx-0.1.0.dev3/src/djangx/core/wsgi.py

@@ -0,0 +1,22 @@
+"""
+WSGI config.
+
+It exposes the WSGI callable as a module-level variable named ``app``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/6.0/howto/deployment/wsgi/
+"""
+
+from . import DJANGO_SETTINGS_MODULE
+
+if DJANGO_SETTINGS_MODULE is None:
+    from . import print_help_message
+
+    print_help_message()
+else:
+    from os import environ
+
+    from django.core.wsgi import get_wsgi_application
+
+    environ.setdefault("DJANGO_SETTINGS_MODULE", DJANGO_SETTINGS_MODULE)
+    application = get_wsgi_application()

djangx-0.1.0.dev2/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 2.4
-Name: djangX
-Version: 0.1.0.dev2
-Summary: Add your description here
-Author: Kevin Wakhisi
-Author-email: Kevin Wakhisi <kevin@treeolive.tech>
-License-Expression: MIT
-License-File: LICENSE
-Requires-Dist: django>=6.1.2
-Requires-Python: >=3.14
-Description-Content-Type: text/markdown
-

djangx-0.1.0.dev2/pyproject.toml

@@ -1,48 +0,0 @@
-[project]
-name = "djangX"
-version = "0.1.0.dev2"
-description = "Add your description here"
-readme = "README.md"
-license = "MIT"
-license-files = ["LICENSE"]
-requires-python = ">=3.14"
-dependencies = ["django>=6.1.2"]
-
-[[project.authors]]
-name = "Kevin Wakhisi"
-email = "kevin@treeolive.tech"
-
-[project.scripts]
-djangx = "djangx.entrypoints.cli:main"
-djx = "djangx.entrypoints.cli:main"
-
-[build-system]
-requires = ["uv_build>=0.13.4,<0.14.0"]
-build-backend = "uv_build"
-
-[dependency-groups]
-dev = ["poethepoet>=0.49.0"]
-
-[tool.uv]
-preview-features = [
-    "format-command",
-    "check-command",
-]
-
-[[tool.uv.index]]
-name = "testpypi"
-url = "https://test.pypi.org/simple/"
-publish-url = "https://test.pypi.org/legacy/"
-explicit = true
-
-[[tool.poe.tasks.format.sequence]]
-cmd = "uv format"
-
-[[tool.poe.tasks.lint.sequence]]
-cmd = "uv format --check"
-
-[[tool.poe.tasks.lint.sequence]]
-cmd = "uv lock --check"
-
-[[tool.poe.tasks.lint.sequence]]
-cmd = "uv check"

djangx-0.1.0.dev2/pyproject.toml.orig

@@ -1,40 +0,0 @@
-[project]
-name = "djangX"
-version = "0.1.0.dev2"
-description = "Add your description here"
-readme = "README.md"
-license = "MIT"
-license-files = ["LICENSE"]
-authors = [{ name = "Kevin Wakhisi", email = "kevin@treeolive.tech" }]
-requires-python = ">=3.14"
-dependencies = ["django>=6.1.2"]
-
-[project.scripts]
-djangx = "djangx.entrypoints.cli:main"
-djx = "djangx.entrypoints.cli:main"
-
-[build-system]
-requires = ["uv_build>=0.13.4,<0.14.0"]
-build-backend = "uv_build"
-
-[dependency-groups]
-dev = ["poethepoet>=0.49.0"]
-
-[tool.uv]
-preview-features = ["format-command", "check-command"]
-
-[tool.poe.tasks.format]
-sequence = [{ cmd = "uv format" }]
-
-[tool.poe.tasks.lint]
-sequence = [
-    { cmd = "uv format --check" },
-    { cmd = "uv lock --check" },
-    { cmd = "uv check" },
-]
-
-[[tool.uv.index]]
-name = "testpypi"
-url = "https://test.pypi.org/simple/"
-publish-url = "https://test.pypi.org/legacy/"
-explicit = true

djangx-0.1.0.dev2/src/djangx/entrypoints/cli.py

@@ -1,6 +0,0 @@
-def main() -> None:
-    print("Hello from djangX!")
-
-
-if __name__ == "__main__":
-    main()