TAILWIND_CLI_VERSION defaults to 'latest'.

Author: oliverandrich

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 4.1.0
+
+- TAILWIND_CLI_VERSION defaults to "latest" now. In case it is set to this value,
+  django-tailwind-cli tries to determine which version is the latest version of Tailwind CSS. If it is not able to access the internet, it uses a fallback version defined in django_tailwind_cli.config.FALLBACK_VERSION. Currently,
+  it is set to 4.0.6.
+
 ## 4.0.1
 
 - Various fixes for the documentation.

docs/settings.md

@@ -11,10 +11,19 @@ The package can be configured by a few settings, which can be overwritten in the
 your project.
 
 `TAILWIND_CLI_VERSION`
-: **Default**: `"4.0.0"`
+: **Default**: `"latest"`
 
     This defines the version of the CLI and of Tailwind CSS you want to use in your project.
 
+    If it is set to `latest`, the management commands try to determine the most recent version of Tailwind CSS by placing a request to GitHub and parse the location header of the redirect. If this is not possible a fallback version is used. This version is defined in the module `django_tailwind_cli.config`.
+
+    If you want to pinpoint your setup to certain version of Tailwind CSS, then you can set `TAILWIND_CLI_VERSION`to a fixed version number.
+
+    For example:
+    ```python
+    TAILWIND_CLI_VERSION = "3.4.17"
+    ```
+
 `TAILWIND_CLI_PATH`
 : **Default**: `"~/.local/bin/"`
 

pyproject.toml

@@ -50,8 +50,6 @@ dev = [
     "pytest-randomly>=3.15.0",
     "pytest>=8.3.3",
     "django-stubs[compatible-mypy]>=5.1.1",
-    "tox>=4.23.2",
-    "tox-uv>=1.16.0",
 ]
 
 [build-system]

src/django_tailwind_cli/config.py

@@ -4,9 +4,12 @@
 from pathlib import Path
 from typing import Optional
 
+import requests
 from django.conf import settings
 from semver import Version
 
+FALLBACK_VERSION = "4.0.6"
+
 
 @dataclass
 class Config:
@@ -49,6 +52,33 @@ def build_cmd(self) -> list[str]:
         return result
 
 
+def get_version() -> tuple[str, Version]:
+    """
+    Retrieves the version of Tailwind CSS specified in the Django settings or fetches the latest
+    version from the Tailwind CSS GitHub repository.
+
+    Returns:
+        tuple[str, Version]: A tuple containing the version string and the parsed Version object.
+
+    Raises:
+        ValueError: If the TAILWIND_CLI_SRC_REPO setting is None when the version is set to
+        "latest".
+    """
+    version_str = getattr(settings, "TAILWIND_CLI_VERSION", "latest")
+
+    if version_str == "latest":
+        repo_url = getattr(settings, "TAILWIND_CLI_SRC_REPO", "tailwindlabs/tailwindcss")
+        if not repo_url:
+            raise ValueError("TAILWIND_CLI_SRC_REPO must not be None.")
+        r = requests.get(f"https://github.com/{repo_url}/releases/latest/", timeout=2)
+        if r.ok and "location" in r.headers:
+            version_str = r.headers["location"].rstrip("/").split("/")[-1].replace("v", "")
+        else:
+            version_str = FALLBACK_VERSION
+
+    return version_str, Version.parse(version_str)
+
+
 def get_config() -> Config:
     if settings.STATICFILES_DIRS is None or len(settings.STATICFILES_DIRS) == 0:
         raise ValueError("STATICFILES_DIRS is empty. Please add a path to your static files.")
@@ -67,8 +97,7 @@ def get_config() -> Config:
     extension = ".exe" if system == "windows" else ""
 
     # Read version from settings
-    version_str = getattr(settings, "TAILWIND_CLI_VERSION", "4.0.0")
-    version = Version.parse(version_str)
+    version_str, version = get_version()
 
     # Determine the full path to the CLI
     cli_path = Path(getattr(settings, "TAILWIND_CLI_PATH", "~/.local/bin/") or settings.BASE_DIR)

src/django_tailwind_cli/templatetags/tailwind_cli.py

@@ -5,13 +5,11 @@
 from django import template
 from django.conf import settings
 
-from django_tailwind_cli import config
-
 register = template.Library()
 
 
 @register.inclusion_tag("tailwind_cli/tailwind_css.html")  # type: ignore
 def tailwind_css() -> dict[str, Union[bool, str]]:
     """Template tag to include the css files into the html templates."""
-    c = config.get_config()
-    return {"debug": settings.DEBUG, "tailwind_dist_css": str(c.dist_css_base)}
+    dist_css_base = getattr(settings, "TAILWIND_CLI_DIST_CSS", "css/tailwind.css")
+    return {"debug": settings.DEBUG, "tailwind_dist_css": str(dist_css_base)}

tests/test_config.py

@@ -2,15 +2,67 @@
 
 import pytest
 from django.conf import LazySettings
+from pytest_django.fixtures import SettingsWrapper
 from pytest_mock import MockerFixture
 
-from django_tailwind_cli.config import get_config
+from django_tailwind_cli.config import get_config, get_version
 
 
 @pytest.fixture(autouse=True)
-def configure_settings(settings: LazySettings):
+def configure_settings(
+    settings: LazySettings,
+    mocker: MockerFixture,
+):
     settings.BASE_DIR = Path("/home/user/project")
     settings.STATICFILES_DIRS = (settings.BASE_DIR / "assets",)
+    request_get = mocker.patch("requests.get")
+    request_get.return_value.headers = {"location": "https://github.com/tailwindlabs/tailwindcss/releases/tag/v4.0.10"}
+
+
+@pytest.mark.parametrize(
+    "version_str, version",
+    [
+        ("4.0.0", (4, 0, 0)),
+        ("3.4.17", (3, 4, 17)),
+    ],
+)
+def test_get_version(settings: SettingsWrapper, version_str: str, version: tuple[int, int, int]):
+    settings.TAILWIND_CLI_VERSION = version_str
+    r_version_str, r_version = get_version()
+    assert r_version_str == version_str
+    assert r_version.major == version[0]
+    assert r_version.minor == version[1]
+    assert r_version.patch == version[2]
+
+
+def test_get_version_latest(settings: SettingsWrapper):
+    r_version_str, r_version = get_version()
+    assert r_version_str == "4.0.10"
+    assert r_version.major == 4
+    assert r_version.minor == 0
+    assert r_version.patch == 10
+
+
+def test_get_version_latest_without_proper_http_response(mocker: MockerFixture):
+    request_get = mocker.patch("requests.get")
+    request_get.return_value.ok = False
+
+    r_version_str, r_version = get_version()
+    assert r_version_str == "4.0.6"
+    assert r_version.major == 4
+    assert r_version.minor == 0
+    assert r_version.patch == 6
+
+
+def test_get_version_latest_without_redirect(mocker: MockerFixture):
+    request_get = mocker.patch("requests.get")
+    request_get.return_value.headers = {}
+
+    r_version_str, r_version = get_version()
+    assert r_version_str == "4.0.6"
+    assert r_version.major == 4
+    assert r_version.minor == 0
+    assert r_version.patch == 6
 
 
 def test_default_config():