django-style 0.1.0__tar.gz

django_style-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Richard Terry
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

django_style-0.1.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: django-style
+Version: 0.1.0
+Summary: Basic tasteful designs for your Django project
+Author-email: Richard Terry <code@radiac.net>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://radiac.net/projects/django-style/
+Project-URL: Documentation, https://django-style.readthedocs.io/en/latest/
+Project-URL: Source, https://github.com/radiac/django-style
+Project-URL: Bug Tracker, https://github.com/radiac/django-style/issues
+Keywords: django,style,theme
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=4.2
+Dynamic: license-file
+
+## Django Style
+
+Basic tasteful designs for your Django project, with sensible defaults.
+
+Features:
+
+* Themes for plain CSS, Tailwind 4, and Bootstrap 5
+* Mobile support
+* App layout for content with a complex UI
+* Basic menu support
+
+This project won't replace a proper design, but can help make your prototypes pretty.
+
+Pairs particularly well with [nanodjango](https://github.com/radiac/nanodjango/).
+
+### Example
+
+To play with a live example, download
+[example.py](https://raw.githubusercontent.com/radiac/django-style/refs/heads/main/example.py)
+and run with [uv](https://docs.astral.sh/uv/getting-started/installation/):
+
+```
+uvx --with django-style nanodjango run example.py
+```
+
+### Quickstart
+
+1.  Install:
+    ```
+    pip install django-style
+    ```
+
+2.  Add it to `INSTALLED_APPS` in your `settings.py`, and optionally configure it:
+    ```
+    INSTALLED_APPS = [
+        ...
+        "django_style",
+    ]
+
+    STYLE_THEME = "tailwind"  # or "simple" (default) or "bootstrap"
+    STYLE_IS_APP = True  # enable app layout (default is False)
+    ```
+
+3.  Extend `base.html` in your templates:
+    ```
+    {% extends "base.html" %}
+    {% block content %}
+        <p>Hello world</p>
+    {% endblock %}
+
+

django_style-0.1.0/README.md

@@ -0,0 +1,51 @@
+## Django Style
+
+Basic tasteful designs for your Django project, with sensible defaults.
+
+Features:
+
+* Themes for plain CSS, Tailwind 4, and Bootstrap 5
+* Mobile support
+* App layout for content with a complex UI
+* Basic menu support
+
+This project won't replace a proper design, but can help make your prototypes pretty.
+
+Pairs particularly well with [nanodjango](https://github.com/radiac/nanodjango/).
+
+### Example
+
+To play with a live example, download
+[example.py](https://raw.githubusercontent.com/radiac/django-style/refs/heads/main/example.py)
+and run with [uv](https://docs.astral.sh/uv/getting-started/installation/):
+
+```
+uvx --with django-style nanodjango run example.py
+```
+
+### Quickstart
+
+1.  Install:
+    ```
+    pip install django-style
+    ```
+
+2.  Add it to `INSTALLED_APPS` in your `settings.py`, and optionally configure it:
+    ```
+    INSTALLED_APPS = [
+        ...
+        "django_style",
+    ]
+
+    STYLE_THEME = "tailwind"  # or "simple" (default) or "bootstrap"
+    STYLE_IS_APP = True  # enable app layout (default is False)
+    ```
+
+3.  Extend `base.html` in your templates:
+    ```
+    {% extends "base.html" %}
+    {% block content %}
+        <p>Hello world</p>
+    {% endblock %}
+
+

django_style-0.1.0/django_style/__init__.py

@@ -0,0 +1,5 @@
+from .utils import Nav, get_base
+
+__all__ = ["Nav", "get_base"]
+
+__version__ = "0.1.0"

django_style-0.1.0/django_style/apps.py

@@ -0,0 +1,18 @@
+from django.apps import AppConfig
+from django.conf import settings
+
+
+class StyleConfig(AppConfig):
+    name = "django_style"
+
+    def ready(self):
+        # Inject the django_style template context processor
+        if hasattr(settings, "TEMPLATES"):
+            for template in settings.TEMPLATES:
+                if (
+                    "OPTIONS" in template
+                    and "context_processors" in template["OPTIONS"]
+                ):
+                    template["OPTIONS"]["context_processors"].append(
+                        "django_style.context_processors.django_style"
+                    )

django_style-0.1.0/django_style/constants.py

@@ -0,0 +1,6 @@
+# Known themes, for validation
+THEMES = {
+    "simple",
+    "bootstrap",
+    "tailwind",
+}

django_style-0.1.0/django_style/context_processors.py

@@ -0,0 +1,13 @@
+from django.conf import settings
+
+from .utils import get_base
+
+DEFAULT_THEME = "simple"
+
+
+def django_style(request):
+    theme = getattr(settings, "STYLE_THEME", DEFAULT_THEME)
+    return {
+        "STYLE_BASE": get_base(theme),
+        "STYLE_IS_APP": getattr(settings, "STYLE_IS_APP", False),
+    }

django_style-0.1.0/django_style/utils.py

@@ -0,0 +1,27 @@
+from django.urls import reverse_lazy
+
+from .constants import THEMES
+
+
+class Nav:
+    """
+    Describe a navigation item
+    """
+
+    def __init__(self, label: str, view: str):
+        self.label = label
+        self.view = view
+        self.url = reverse_lazy(view)
+
+
+def get_base(theme: str) -> str:
+    """
+    Given a theme name, generate the STYLE_BASE value
+
+    May be useful if wanting to override the STYLE_BASE in a context, eg:
+
+        render(..., context={"STYLE_BASE": get_base("simple")})
+    """
+    if theme not in THEMES:
+        raise ValueError(f"Unknown django-style theme: {theme}")
+    return f"django_style/{theme}/base.html"

django_style-0.1.0/django_style.egg-info/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: django-style
+Version: 0.1.0
+Summary: Basic tasteful designs for your Django project
+Author-email: Richard Terry <code@radiac.net>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://radiac.net/projects/django-style/
+Project-URL: Documentation, https://django-style.readthedocs.io/en/latest/
+Project-URL: Source, https://github.com/radiac/django-style
+Project-URL: Bug Tracker, https://github.com/radiac/django-style/issues
+Keywords: django,style,theme
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=4.2
+Dynamic: license-file
+
+## Django Style
+
+Basic tasteful designs for your Django project, with sensible defaults.
+
+Features:
+
+* Themes for plain CSS, Tailwind 4, and Bootstrap 5
+* Mobile support
+* App layout for content with a complex UI
+* Basic menu support
+
+This project won't replace a proper design, but can help make your prototypes pretty.
+
+Pairs particularly well with [nanodjango](https://github.com/radiac/nanodjango/).
+
+### Example
+
+To play with a live example, download
+[example.py](https://raw.githubusercontent.com/radiac/django-style/refs/heads/main/example.py)
+and run with [uv](https://docs.astral.sh/uv/getting-started/installation/):
+
+```
+uvx --with django-style nanodjango run example.py
+```
+
+### Quickstart
+
+1.  Install:
+    ```
+    pip install django-style
+    ```
+
+2.  Add it to `INSTALLED_APPS` in your `settings.py`, and optionally configure it:
+    ```
+    INSTALLED_APPS = [
+        ...
+        "django_style",
+    ]
+
+    STYLE_THEME = "tailwind"  # or "simple" (default) or "bootstrap"
+    STYLE_IS_APP = True  # enable app layout (default is False)
+    ```
+
+3.  Extend `base.html` in your templates:
+    ```
+    {% extends "base.html" %}
+    {% block content %}
+        <p>Hello world</p>
+    {% endblock %}
+
+

django_style-0.1.0/django_style.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+django_style/__init__.py
+django_style/apps.py
+django_style/constants.py
+django_style/context_processors.py
+django_style/utils.py
+django_style.egg-info/PKG-INFO
+django_style.egg-info/SOURCES.txt
+django_style.egg-info/dependency_links.txt
+django_style.egg-info/requires.txt
+django_style.egg-info/top_level.txt
+tests/test_apps.py
+tests/test_settings.py

django_style-0.1.0/django_style.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django_style-0.1.0/django_style.egg-info/requires.txt

@@ -0,0 +1 @@
+Django>=4.2

django_style-0.1.0/django_style.egg-info/top_level.txt

@@ -0,0 +1 @@
+django_style

django_style-0.1.0/pyproject.toml

@@ -0,0 +1,73 @@
+[project]
+name = "django-style"
+description = "Basic tasteful designs for your Django project"
+dynamic = ["version"]
+authors = [
+    { name="Richard Terry", email="code@radiac.net" },
+]
+readme = "README.md"
+license = "BSD-3-Clause"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: Django",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+keywords = ["django", "style", "theme"]
+requires-python = ">=3.7"
+dependencies = [
+    "Django>=4.2",
+]
+
+[project.urls]
+"Homepage" = "https://radiac.net/projects/django-style/"
+"Documentation" = "https://django-style.readthedocs.io/en/latest/"
+"Source" = "https://github.com/radiac/django-style"
+"Bug Tracker" = "https://github.com/radiac/django-style/issues"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["django_style*"]
+exclude = ["docs*", "tests*", "src*", "dist*"]
+
+[tool.setuptools.dynamic]
+version = {attr = "django_style.__version__"}
+
+[tool.pytest.ini_options]
+addopts = "--cov=django_style --cov-report=term --cov-report=html"
+testpaths = [
+    "tests",
+    "django_style",
+]
+pythonpath = [
+    ".",
+]
+DJANGO_SETTINGS_MODULE = "tests.test_project.settings"
+
+[tool.coverage.run]
+source = ["django_style"]
+
+[tool.ruff]
+line-length = 88
+select = ["E", "F"]
+ignore = [
+    "E501",  # line length
+]
+exclude = [
+    ".tox",
+    ".git",
+    "*/static/CACHE/*",
+    "docs",
+    "node_modules",
+    "src",
+    "dist",
+]
+
+[tool.djlint]
+profile="django"

django_style-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

django_style-0.1.0/tests/test_apps.py

@@ -0,0 +1,6 @@
+from django.conf import settings
+
+
+def test_context_processor_added():
+    context_processors = settings.TEMPLATES[0]["OPTIONS"]["context_processors"]
+    assert "django_style.context_processors.django_style" in context_processors

django_style-0.1.0/tests/test_settings.py

@@ -0,0 +1,30 @@
+import pytest
+from django.test import override_settings
+from django.test.client import Client
+
+
+def test_default_settings(client):
+    response = client.get("/")
+    assert response.status_code == 200
+
+    context = response.context
+    assert context["STYLE_BASE"] == "django_style/simple/base.html"
+    assert context["STYLE_IS_APP"] is False
+    assert "simple/styles.css" in response.content.decode()
+
+
+@override_settings(STYLE_THEME="bootstrap", STYLE_IS_APP=True)
+def test_custom_settings_applied(client):
+    response = client.get("/")
+    assert response.status_code == 200
+
+    context = response.context
+    assert context["STYLE_BASE"] == "django_style/bootstrap/base.html"
+    assert context["STYLE_IS_APP"] is True
+    assert "bootstrap/styles.css" in response.content.decode()
+
+
+@override_settings(STYLE_THEME="_undefined")
+def test_unknown_theme_caught(client):
+    with pytest.raises(ValueError, match="Unknown django-style theme: _undefined"):
+        _ = client.get("/")