bragi-theme-zelda 0.1.1__tar.gz

bragi_theme_zelda-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Eelco Wesemann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bragi_theme_zelda-0.1.1/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: bragi-theme-zelda
+Version: 0.1.1
+Summary: Link's-Awakening-flavoured theme for the bragi CMS, used by zelda.eelcowesemann.nl
+License: MIT
+License-File: LICENSE
+Author: Eelco Wesemann
+Author-email: claude-ai@init1.nl
+Requires-Python: >=3.14,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: jinja2 (>=3.1,<4.0)
+Description-Content-Type: text/markdown
+
+# bragi-theme-zelda
+
+A Link's-Awakening-flavoured theme for the [bragi CMS](https://github.com/sgaduuw/bragi),
+deployed at [zelda.eelcowesemann.nl](https://zelda.eelcowesemann.nl).
+
+This is a site-specific theme. The visual choices are opinionated for one Zelda fan site
+(primarily Link's Awakening walkthroughs with secondary Ocarina of Time coverage) and are
+not intended as a general-purpose Zelda theme.
+
+## Theme highlights
+
+- **Game Boy LCD palette:** 4-shade GB green light mode, 4-shade GB Pocket greyscale dark
+  mode. Two real handheld LCDs under one roof; `prefers-color-scheme` determines which.
+- **Pixel headings over readable body:** Press Start 2P for short strings (headings, labels,
+  UI chrome), Inter for body text, JetBrains Mono for code.
+- **MAP-styled sidebar tree:** Current section's siblings and children visible at a glance,
+  styled as a pause-menu MAP panel. Walkthrough hierarchy (game, dungeon, room) navigable
+  without hunting through a top-level nav.
+- **OoT section chrome flip:** Royal-blue + gold accent shift in the Ocarina of Time section
+  via `data-section="oot"`. Body stays GB-green for cohesion; chrome (top bar, image frames,
+  links) signals the switch.
+- **GB Pocket greyscale dark mode:** A real GB Pocket palette (light grey on near-black),
+  not a colour inversion. Different hardware era, coherent aesthetic family.
+- **Seven cosplay motifs:** text-box callouts (Owl / Marin / Tarin / Ulrira portraits),
+  rupee counter, PUSH START splash, item-acquired flourish between sections, pause-menu
+  inventory homepage, ZZZZZ 404, heart-container `<hr>`, inventory-row pinned posts.
+- **`prefers-reduced-motion` respected:** Any animation that moves (ZZZZZ float, item-
+  acquired scroll, PUSH START blink) switches to a static render.
+
+## Status: v0.1.1
+
+v0.1.1 is the first PyPI-published release. It ships the same full visual system as v0.1.0
+(MAP sidebar, chrome, pause-menu home, ZZZZZ 404, all four cosplay JS motifs, and subsetted
+woff2 fonts). **Character portraits, item tiles, the heart-container, and the 404 scene art
+are still placeholder PNGs** (Pillow-generated text-on-coloured-square). The CSS / JS /
+templates reference the correct sprite filenames, so a future release swaps in real art via
+per-file PNG replacement with no code changes.
+
+## Asset provenance
+
+Fonts and sprites are documented row-by-row in [ASSETS.md](ASSETS.md). No ROM-ripped
+Nintendo assets; see ASSETS.md for the full sourcing and licence detail.
+
+## Installing
+
+The theme is installed into a downstream bragi deployment via a thin `Dockerfile` that
+builds on the published bragi images and `pip install`s this package. From v0.1.1 the
+package is published to PyPI on every GitHub Release; v0.1.0 is git-tag-only.
+
+### Delivery container
+
+```dockerfile
+FROM ghcr.io/sgaduuw/bragi-delivery:v1.26.0
+
+# Install from PyPI (pin to a specific version).
+RUN pip install --no-cache-dir bragi-theme-zelda==0.1.1
+
+# For development against an unreleased commit, use the git+https form instead:
+# RUN pip install --no-cache-dir \
+#     "git+https://github.com/sgaduuw/bragi-theme-zelda.git@v0.1.0"
+```
+
+### Admin container
+
+```dockerfile
+FROM ghcr.io/sgaduuw/bragi-admin:v1.26.0
+
+# Install from PyPI (pin to a specific version).
+RUN pip install --no-cache-dir bragi-theme-zelda==0.1.1
+
+# For development against an unreleased commit, use the git+https form instead:
+# RUN pip install --no-cache-dir \
+#     "git+https://github.com/sgaduuw/bragi-theme-zelda.git@v0.1.0"
+```
+
+Both containers need the package so template lookups work from the admin preview path and
+from the public delivery path. Restart both after installation to pick up the plugin.
+
+Replace the version pin with the version to deploy. v0.1.1 is the first PyPI-published
+release; v0.1.0 is git-tag-only.
+
+## Development
+
+### Prerequisites
+
+- Python 3.14+
+- [Poetry](https://python-poetry.org/)
+
+### Install
+
+```sh
+poetry install
+```
+
+### Run against a bragi dev checkout (editable install)
+
+```sh
+# From this project's directory, install into bragi's venv as an editable package:
+cd ../bragi && poetry run pip install -e ../bragi-theme-zelda
+
+# Then in bragi's working tree, point the Zelda site's theme to "zelda"
+# via the admin UI or CLI, and reload the delivery process to pick up template changes.
+```
+
+### Commands
+
+```sh
+# Run the test suite
+poetry run pytest
+
+# Lint
+poetry run ruff check src/ tests/
+
+# Format-check
+poetry run ruff format --check src/ tests/
+
+# Type-check
+poetry run mypy src/
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE). Theme code and original assets are MIT-licensed. Third-party
+fonts are under their respective open-source licences; see [ASSETS.md](ASSETS.md).
+

bragi_theme_zelda-0.1.1/README.md

@@ -0,0 +1,124 @@
+# bragi-theme-zelda
+
+A Link's-Awakening-flavoured theme for the [bragi CMS](https://github.com/sgaduuw/bragi),
+deployed at [zelda.eelcowesemann.nl](https://zelda.eelcowesemann.nl).
+
+This is a site-specific theme. The visual choices are opinionated for one Zelda fan site
+(primarily Link's Awakening walkthroughs with secondary Ocarina of Time coverage) and are
+not intended as a general-purpose Zelda theme.
+
+## Theme highlights
+
+- **Game Boy LCD palette:** 4-shade GB green light mode, 4-shade GB Pocket greyscale dark
+  mode. Two real handheld LCDs under one roof; `prefers-color-scheme` determines which.
+- **Pixel headings over readable body:** Press Start 2P for short strings (headings, labels,
+  UI chrome), Inter for body text, JetBrains Mono for code.
+- **MAP-styled sidebar tree:** Current section's siblings and children visible at a glance,
+  styled as a pause-menu MAP panel. Walkthrough hierarchy (game, dungeon, room) navigable
+  without hunting through a top-level nav.
+- **OoT section chrome flip:** Royal-blue + gold accent shift in the Ocarina of Time section
+  via `data-section="oot"`. Body stays GB-green for cohesion; chrome (top bar, image frames,
+  links) signals the switch.
+- **GB Pocket greyscale dark mode:** A real GB Pocket palette (light grey on near-black),
+  not a colour inversion. Different hardware era, coherent aesthetic family.
+- **Seven cosplay motifs:** text-box callouts (Owl / Marin / Tarin / Ulrira portraits),
+  rupee counter, PUSH START splash, item-acquired flourish between sections, pause-menu
+  inventory homepage, ZZZZZ 404, heart-container `<hr>`, inventory-row pinned posts.
+- **`prefers-reduced-motion` respected:** Any animation that moves (ZZZZZ float, item-
+  acquired scroll, PUSH START blink) switches to a static render.
+
+## Status: v0.1.1
+
+v0.1.1 is the first PyPI-published release. It ships the same full visual system as v0.1.0
+(MAP sidebar, chrome, pause-menu home, ZZZZZ 404, all four cosplay JS motifs, and subsetted
+woff2 fonts). **Character portraits, item tiles, the heart-container, and the 404 scene art
+are still placeholder PNGs** (Pillow-generated text-on-coloured-square). The CSS / JS /
+templates reference the correct sprite filenames, so a future release swaps in real art via
+per-file PNG replacement with no code changes.
+
+## Asset provenance
+
+Fonts and sprites are documented row-by-row in [ASSETS.md](ASSETS.md). No ROM-ripped
+Nintendo assets; see ASSETS.md for the full sourcing and licence detail.
+
+## Installing
+
+The theme is installed into a downstream bragi deployment via a thin `Dockerfile` that
+builds on the published bragi images and `pip install`s this package. From v0.1.1 the
+package is published to PyPI on every GitHub Release; v0.1.0 is git-tag-only.
+
+### Delivery container
+
+```dockerfile
+FROM ghcr.io/sgaduuw/bragi-delivery:v1.26.0
+
+# Install from PyPI (pin to a specific version).
+RUN pip install --no-cache-dir bragi-theme-zelda==0.1.1
+
+# For development against an unreleased commit, use the git+https form instead:
+# RUN pip install --no-cache-dir \
+#     "git+https://github.com/sgaduuw/bragi-theme-zelda.git@v0.1.0"
+```
+
+### Admin container
+
+```dockerfile
+FROM ghcr.io/sgaduuw/bragi-admin:v1.26.0
+
+# Install from PyPI (pin to a specific version).
+RUN pip install --no-cache-dir bragi-theme-zelda==0.1.1
+
+# For development against an unreleased commit, use the git+https form instead:
+# RUN pip install --no-cache-dir \
+#     "git+https://github.com/sgaduuw/bragi-theme-zelda.git@v0.1.0"
+```
+
+Both containers need the package so template lookups work from the admin preview path and
+from the public delivery path. Restart both after installation to pick up the plugin.
+
+Replace the version pin with the version to deploy. v0.1.1 is the first PyPI-published
+release; v0.1.0 is git-tag-only.
+
+## Development
+
+### Prerequisites
+
+- Python 3.14+
+- [Poetry](https://python-poetry.org/)
+
+### Install
+
+```sh
+poetry install
+```
+
+### Run against a bragi dev checkout (editable install)
+
+```sh
+# From this project's directory, install into bragi's venv as an editable package:
+cd ../bragi && poetry run pip install -e ../bragi-theme-zelda
+
+# Then in bragi's working tree, point the Zelda site's theme to "zelda"
+# via the admin UI or CLI, and reload the delivery process to pick up template changes.
+```
+
+### Commands
+
+```sh
+# Run the test suite
+poetry run pytest
+
+# Lint
+poetry run ruff check src/ tests/
+
+# Format-check
+poetry run ruff format --check src/ tests/
+
+# Type-check
+poetry run mypy src/
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE). Theme code and original assets are MIT-licensed. Third-party
+fonts are under their respective open-source licences; see [ASSETS.md](ASSETS.md).

bragi_theme_zelda-0.1.1/pyproject.toml

@@ -0,0 +1,69 @@
+[tool.poetry]
+name = "bragi-theme-zelda"
+version = "0.1.1"
+description = "Link's-Awakening-flavoured theme for the bragi CMS, used by zelda.eelcowesemann.nl"
+authors = ["Eelco Wesemann <claude-ai@init1.nl>"]
+license = "MIT"
+readme = "README.md"
+packages = [{ include = "bragi_theme_zelda", from = "src" }]
+include = [
+    "src/bragi_theme_zelda/templates/**/*",
+    "src/bragi_theme_zelda/static/**/*",
+]
+
+[tool.poetry.dependencies]
+python = "^3.14"
+# jinja2 is imported directly by plugin.py (PackageLoader, Environment type).
+# bragi is the host app and is always present in the deployment environment;
+# it is a dev dep here (git dep) so the published wheel has no direct-URL
+# dependency that PyPI rejects.
+jinja2 = "^3.1"
+
+[tool.poetry.group.dev.dependencies]
+# bragi is the host. Git dep because bragi isn't on PyPI (the bragi name there
+# is held by an unrelated project per bragi's CONTEXT.md). Lives in dev so
+# the published wheel carries no direct-URL dep (PyPI rejects those).
+bragi = { git = "https://github.com/sgaduuw/bragi.git", tag = "v1.26.0" }
+ruff = "^0.6"
+mypy = "^1.11"
+pytest = "^8.0"
+fonttools = "^4.63.0"
+brotli = "^1.2.0"
+
+[tool.poetry.plugins."bragi.plugins"]
+theme_zelda = "bragi_theme_zelda.plugin"
+
+[tool.ruff]
+line-length = 88
+# ruff 0.6.x tops out at py313; bump when upgrading ruff past 0.7.
+target-version = "py313"
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP", "N", "RUF"]
+
+[tool.mypy]
+python_version = "3.14"
+strict = true
+files = ["src"]
+
+# bragi does not ship py.typed (it's deploy-as-container, not a PyPI lib).
+# Silence mypy's import-untyped error for the bragi imports in this package.
+[[tool.mypy.overrides]]
+module = "bragi.*"
+ignore_missing_imports = true
+
+# pluggy's @hookimpl decorator doesn't preserve the decorated function's
+# type signature, so mypy fires "untyped-decorator" in strict mode.
+# The hook contract is tested behaviourally; suppressing here is intentional.
+[[tool.mypy.overrides]]
+module = "bragi_theme_zelda.plugin"
+disable_error_code = ["untyped-decorator"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

bragi_theme_zelda-0.1.1/src/bragi_theme_zelda/__init__.py

@@ -0,0 +1,10 @@
+"""bragi-theme-zelda: a Link's-Awakening-flavoured bragi theme."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("bragi-theme-zelda")
+except PackageNotFoundError:
+    __version__ = "0.0.0+unknown"
+
+__all__ = ["__version__"]

bragi_theme_zelda-0.1.1/src/bragi_theme_zelda/image_frame.py

@@ -0,0 +1,22 @@
+"""GB-frame wrapper for body images.
+
+Takes the HTML for an already-pictureified <picture> block and wraps it
+in <figure class="gb-frame"> with a pixel-font caption bar. The caption
+comes from the markdown directive or, if absent, from the inner img alt.
+
+Caption is uppercased to match the in-game text-box label convention.
+"""
+
+from __future__ import annotations
+
+
+def wrap_picture(picture_html: str, caption: str = "") -> str:
+    label_html = ""
+    if caption:
+        label_html = f'<span class="gb-frame__label">{caption.upper()}</span>'
+    return (
+        f'<figure class="gb-frame">'
+        f"{label_html}"
+        f'<div class="gb-frame__inner">{picture_html}</div>'
+        f"</figure>"
+    )