Removed django-appconf. Switched from pyright to mypy.

Author: oliverandrich

.github/workflows/release.yml

@@ -118,4 +118,4 @@ jobs:
   #     uses: pypa/gh-action-pypi-publish@release/v1.10
   #     with:
   #       repository-url: https://test.pypi.org/legacy/
-  #       skip-existing: true
+  #       skip-existing: true

.pre-commit-config.yaml

@@ -16,30 +16,34 @@ repos:
       - id: check-json
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.6.9"
+    rev: "v0.7.4"
     hooks:
       - id: ruff
       - id: ruff-format
 
-  - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.384
-    hooks:
-      - id: pyright
-
-  - repo: https://github.com/adamchainz/djade-pre-commit
-    rev: "1.3.0"
-    hooks:
-    -   id: djade
-        args: [--target-version, "4.2"]
-
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.17.0
+    rev: v3.19.0
     hooks:
     - id: pyupgrade
       args: [--py39-plus]
 
   - repo: https://github.com/adamchainz/django-upgrade
-    rev: "1.21.0"
+    rev: "1.22.1"
     hooks:
     - id: django-upgrade
       args: [--target-version, "4.2"]
+
+  - repo: local
+    hooks:
+    - id: mypy
+      name: mypy
+      language: system
+      types: [python]
+      entry: uv run mypy
+      require_serial: true
+
+  - repo: https://github.com/adamchainz/djade-pre-commit
+    rev: "1.3.2"
+    hooks:
+    -   id: djade
+        args: [--target-version, "4.2"]

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.20.0
+
+- Removed django-appconf again.
+- Switched from pyright to mypy for type checking.
+- Fixed broken links in the documentation.
+
 ## 2.19.0
 
 - Transfered the project to django-commons.

pyproject.toml

@@ -28,7 +28,6 @@ dependencies = [
     "django>=4.2",
     "certifi>=2023.7.22,<2025.0.0",
     "django-typer>=2.1.2",
-    "django-appconf>=1.0.6",
 ]
 
 [project.optional-dependencies]
@@ -41,13 +40,13 @@ Repository = "https://github.com/django-commons/django-tailwind-cli"
 
 [tool.uv]
 dev-dependencies = [
-    "django-types>=0.19.1",
     "pytest-cov>=5.0.0",
     "pytest-django>=4.9.0",
     "pytest-mock>=3.14.0",
     "pytest-randomly>=3.15.0",
     "pytest-sugar>=1.0.0",
     "pytest>=8.3.3",
+    "django-stubs[compatible-mypy]>=5.1.1",
 ]
 
 [build-system]
@@ -74,12 +73,13 @@ exclude = '''
 )/
 '''
 
-# Pyright
-[tool.pyright]
-venvPath = "."
-venv = ".venv"
-typeCheckingMode = "basic"
-ignore = ["./tests/**/*"]
+# mypy
+[tool.mypy]
+plugins = ["mypy_django_plugin.main"]
+
+[tool.django-stubs]
+django_settings_module = "tests.settings"
+strict_settings = false
 
 # Ruff
 [tool.ruff]

src/django_tailwind_cli/conf.py

@@ -1,18 +1,43 @@
-from appconf import AppConf
-from django.conf import settings  # noqa: F401
+from django.conf import settings
 
 DEFAULT_SRC_REPO = "tailwindlabs/tailwindcss"
 
 
-class TailwindCliAppConfig(AppConf):
-    VERSION = "3.4.11"
-    PATH = "~/.local/bin/"
-    AUTOMATIC_DOWNLOAD = True
-    SRC_CSS = None
-    DIST_CSS = "css/tailwind.css"
-    CONFIG_FILE = "tailwind.config.js"
-    SRC_REPO = "tailwindlabs/tailwindcss"
-    ASSET_NAME = "tailwindcss"
+def get_tailwind_cli_version() -> str:
+    """Get the version of the Tailwind CSS CLI."""
+    return getattr(settings, "TAILWIND_CLI_VERSION", "3.4.11")
 
-    class Meta:
-        prefix = "TAILWIND_CLI"
+
+def get_tailwind_cli_path() -> str:
+    """Get the path to the Tailwind CSS CLI."""
+    return getattr(settings, "TAILWIND_CLI_PATH", "~/.local/bin/")
+
+
+def get_tailwind_cli_automatic_download() -> bool:
+    """Get the automatic download setting for the Tailwind CSS CLI."""
+    return getattr(settings, "TAILWIND_CLI_AUTOMATIC_DOWNLOAD", True)
+
+
+def get_tailwind_cli_src_css() -> None | str:
+    """Get the source css file for the Tailwind CSS CLI."""
+    return getattr(settings, "TAILWIND_CLI_SRC_CSS", None)
+
+
+def get_tailwind_cli_dist_css() -> str:
+    """Get the dist css file for the Tailwind CSS CLI."""
+    return getattr(settings, "TAILWIND_CLI_DIST_CSS", "css/tailwind.css")
+
+
+def get_tailwind_cli_config_file() -> str:
+    """Get the config file for the Tailwind CSS CLI."""
+    return getattr(settings, "TAILWIND_CLI_CONFIG_FILE", "tailwind.config.js")
+
+
+def get_tailwind_cli_src_repo() -> str:
+    """Get the source repository for the Tailwind CSS CLI."""
+    return getattr(settings, "TAILWIND_CLI_SRC_REPO", DEFAULT_SRC_REPO)
+
+
+def get_tailwind_cli_asset_name() -> str:
+    """Get the asset name for the Tailwind CSS CLI."""
+    return getattr(settings, "TAILWIND_CLI_ASSET_NAME", "tailwindcss")

src/django_tailwind_cli/management/commands/tailwind.py

@@ -13,12 +13,12 @@
 
 import certifi
 import typer
+from django.conf import settings
 from django.core.management.base import CommandError
 from django.template.utils import get_app_template_dirs
 from django_typer.management import TyperCommand, command, initialize
 
-from django_tailwind_cli import utils
-from django_tailwind_cli.conf import DEFAULT_SRC_REPO, settings
+from django_tailwind_cli import conf, utils
 
 
 class Command(TyperCommand):
@@ -35,7 +35,7 @@ def init(self):
 
         # Before running the actual subcommand, we need to make sure that the CLI is installed and
         # the config file exists.
-        if settings.TAILWIND_CLI_AUTOMATIC_DOWNLOAD:
+        if conf.get_tailwind_cli_automatic_download():
             self.download_cli()
         self._create_tailwind_config_if_not_exists()
 
@@ -50,7 +50,7 @@ def build(self):
             str(utils.get_full_dist_css_path()),
             "--minify",
         ]
-        if settings.TAILWIND_CLI_SRC_CSS is not None:
+        if conf.get_tailwind_cli_src_css() is not None:
             build_cmd.extend(
                 [
                     "--input",
@@ -75,7 +75,7 @@ def watch(self):
             str(utils.get_full_dist_css_path()),
             "--watch",
         ]
-        if settings.TAILWIND_CLI_SRC_CSS is not None:
+        if conf.get_tailwind_cli_src_css() is not None:
             watch_cmd.extend(
                 [
                     "--input",
@@ -89,7 +89,7 @@ def watch(self):
             self._write_success("Stopped watching for changes.")
 
     @command(name="list_templates", help="List the templates of your django project.")
-    def list_templates(self):
+    def list_templates(self) -> None:
         template_files: list[str] = []
         app_template_dirs = get_app_template_dirs("templates")
         for app_template_dir in app_template_dirs:
@@ -272,8 +272,8 @@ def download_cli(self) -> None:
         dest_file = utils.get_full_cli_path()
         extra_msg = (
             ""
-            if settings.TAILWIND_CLI_SRC_REPO == DEFAULT_SRC_REPO
-            else f" from '{settings.TAILWIND_CLI_SRC_REPO}'"
+            if conf.get_tailwind_cli_src_repo() == conf.DEFAULT_SRC_REPO
+            else f" from '{conf.get_tailwind_cli_src_repo()}'"
         )
 
         if dest_file.exists():

src/django_tailwind_cli/templatetags/tailwind_cli.py

@@ -3,13 +3,14 @@
 from typing import Union
 
 from django import template
+from django.conf import settings
 
-from django_tailwind_cli.conf import settings
+from django_tailwind_cli import conf
 
 register = template.Library()
 
 
 @register.inclusion_tag("tailwind_cli/tailwind_css.html")
 def tailwind_css() -> dict[str, Union[bool, str]]:
     """Template tag to include the css files into the html templates."""
-    return {"debug": settings.DEBUG, "tailwind_dist_css": settings.TAILWIND_CLI_DIST_CSS}
+    return {"debug": settings.DEBUG, "tailwind_dist_css": conf.get_tailwind_cli_dist_css()}

src/django_tailwind_cli/utils.py

@@ -9,7 +9,9 @@
 import platform
 from pathlib import Path
 
-from django_tailwind_cli.conf import settings
+from django.conf import settings
+
+from django_tailwind_cli import conf
 
 
 def get_system_and_machine() -> tuple[str, str]:
@@ -32,15 +34,17 @@ def get_download_url() -> str:
     system, machine = get_system_and_machine()
     extension = ".exe" if system == "windows" else ""
     return (
-        f"https://github.com/{settings.TAILWIND_CLI_SRC_REPO}/releases/download/"
-        f"v{settings.TAILWIND_CLI_VERSION}/{settings.TAILWIND_CLI_ASSET_NAME}-{system}-{machine}{extension}"
+        f"https://github.com/{conf.get_tailwind_cli_src_repo}/releases/download/"
+        f"v{conf.get_tailwind_cli_version()}/{conf.get_tailwind_cli_asset_name()}-{system}-{machine}{extension}"
     )
 
 
 def get_full_cli_path() -> Path:
     """Get path to the Tailwind CSS CLI."""
 
-    cli_path = Path(settings.TAILWIND_CLI_PATH).expanduser() if settings.TAILWIND_CLI_PATH else None
+    cli_path = (
+        Path(conf.get_tailwind_cli_path()).expanduser() if conf.get_tailwind_cli_path() else None
+    )
 
     # If Tailwind CSS CLI path points to an existing executable use is.
     if cli_path and cli_path.exists() and cli_path.is_file() and os.access(cli_path, os.X_OK):
@@ -49,7 +53,7 @@ def get_full_cli_path() -> Path:
     # Otherwise try to calculate the full cli path as usual.
     system, machine = get_system_and_machine()
     extension = ".exe" if system == "windows" else ""
-    executable_name = f"tailwindcss-{system}-{machine}-{settings.TAILWIND_CLI_VERSION}{extension}"
+    executable_name = f"tailwindcss-{system}-{machine}-{conf.get_tailwind_cli_version()}{extension}"
     if cli_path is None:
         return Path(settings.BASE_DIR) / executable_name
     else:
@@ -58,10 +62,11 @@ def get_full_cli_path() -> Path:
 
 def get_full_src_css_path() -> Path:
     """Get path to the source css."""
-    if settings.TAILWIND_CLI_SRC_CSS is None:
+    cli_src_css = conf.get_tailwind_cli_src_css()
+    if cli_src_css is None:
         msg = "No source CSS file specified. Please set TAILWIND_SRC_CSS in your settings."
         raise ValueError(msg)
-    return Path(settings.BASE_DIR) / settings.TAILWIND_CLI_SRC_CSS
+    return Path(settings.BASE_DIR) / cli_src_css
 
 
 def get_full_dist_css_path() -> Path:
@@ -70,12 +75,12 @@ def get_full_dist_css_path() -> Path:
         msg = "STATICFILES_DIRS is empty. Please add a path to your static files."
         raise ValueError(msg)
 
-    return Path(settings.STATICFILES_DIRS[0]) / settings.TAILWIND_CLI_DIST_CSS
+    return Path(settings.STATICFILES_DIRS[0]) / conf.get_tailwind_cli_dist_css()
 
 
 def get_full_config_file_path() -> Path:
     """Get path to the tailwind.config.js file."""
-    return Path(settings.BASE_DIR) / settings.TAILWIND_CLI_CONFIG_FILE
+    return Path(settings.BASE_DIR) / conf.get_tailwind_cli_config_file()
 
 
 def validate_settings() -> None: