parody-web 0.1.0__tar.gz

parody_web-0.1.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: parody-web
+Version: 0.1.0
+Summary: Django app that serves a parody build artifact as a public book site, with section-level auth gating (public = online-only subset; owner = full book).
+Author-email: Rico Picone <dr@ricopic.one>
+License: MIT
+Project-URL: Homepage, https://github.com/ricopicone/parody-web
+Project-URL: Issues, https://github.com/ricopicone/parody-web/issues
+Keywords: parody,django,publishing,book,textbook
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: Django<6.0,>=5.0
+
+# parody-web
+
+A reusable **Django app** that serves a [parody](https://github.com/ricopicone/parody)
+build artifact as a public book site, with section-level auth gating. It's the
+*web* surface of the parody ecosystem:
+
+- **`parody`** — core: builds the artifact (and the print/LaTeX side, for now)
+- **`parody-web`** — *this*: renders an artifact as a website
+- *(future)* `parody-print` — if/when the LaTeX side is split out of core
+
+You `pip install parody-web` into a thin per-book Django project; the package is
+generic, so one codebase serves every book site. Each book differs only by
+config + content. First site: the partial *Real-Time Computing* book at
+[rtcbook.org](https://rtcbook.org).
+
+## Access model
+
+The site imports the **full** artifact and gates by section: the public sees
+only `online_only` sections (the openly-licensed subset); the **private** parts
+require login, and only the owner has an account. One deployment serves both the
+public partial book and — to the owner — the whole thing. (If you'd rather the
+full text never touch the database, import the partial `parody build
+--online-only` artifact instead — then there are no private sections.)
+
+## Why a Django app (not a static site)
+
+Parody artifact `html` is Django-template-flavored — it embeds `{% media %}`,
+`{% static %}`, `{% cite %}` etc. This app renders it **natively** through the
+Django template engine (`parody_web.templatetags.parody_web.render_book`), so
+there's no second, lossy tag-resolution renderer to maintain.
+
+## Use it in a project
+
+```python
+# settings.py
+INSTALLED_APPS = [..., "parody_web"]
+BOOK_SLUG = "real-time-computing"     # which imported book is the site root
+```
+```python
+# urls.py
+urlpatterns = [path("", include("parody_web.urls")), ...]
+```
+```bash
+pip install parody-web
+python manage.py migrate
+python manage.py createsuperuser                       # the owner (only account)
+python manage.py import_artifact rtc.json --slug real-time-computing
+```
+
+Provides: `Book`/`Chapter`/`Section` models, the `import_artifact` command
+(upsert-by-slug, idempotent), index + section views, templates (override them in
+your project), and the rendering template tags. Reads `settings.BOOK_SLUG`,
+`MEDIA_URL`, `LOGIN_URL`.
+
+A ready-to-copy thin project — settings, urls, Procfile, and AWS/SSM deploy glue
+— lives in [`example_site/`](example_site/); generate a new book site from it.
+
+## Develop
+
+```bash
+pip install -e .
+python runtests.py            # standalone test suite (tests/settings.py)
+```
+
+## Deploy
+
+AWS via SSM + GitHub Actions, designed for **reuse across book projects**: each
+book site is a small repo (copied from `example_site/`) that pins this package
+and calls the shared reusable workflow (`deploy-reusable.yml`) — improve the
+renderer or the deploy once, every site picks it up. Runbook:
+[`example_site/deploy/AWS.md`](example_site/deploy/AWS.md).
+
+## Status
+
+`0.x` — interfaces may change. Renders the rtc artifact end to end with
+section-level auth gating; 9 tests. `{% cite %}` currently renders `[key]`
+(wire citeproc/a .bib for full citations). Not yet published to PyPI or
+deployed to rtcbook.org (owner steps).

parody_web-0.1.0/README.md

@@ -0,0 +1,78 @@
+# parody-web
+
+A reusable **Django app** that serves a [parody](https://github.com/ricopicone/parody)
+build artifact as a public book site, with section-level auth gating. It's the
+*web* surface of the parody ecosystem:
+
+- **`parody`** — core: builds the artifact (and the print/LaTeX side, for now)
+- **`parody-web`** — *this*: renders an artifact as a website
+- *(future)* `parody-print` — if/when the LaTeX side is split out of core
+
+You `pip install parody-web` into a thin per-book Django project; the package is
+generic, so one codebase serves every book site. Each book differs only by
+config + content. First site: the partial *Real-Time Computing* book at
+[rtcbook.org](https://rtcbook.org).
+
+## Access model
+
+The site imports the **full** artifact and gates by section: the public sees
+only `online_only` sections (the openly-licensed subset); the **private** parts
+require login, and only the owner has an account. One deployment serves both the
+public partial book and — to the owner — the whole thing. (If you'd rather the
+full text never touch the database, import the partial `parody build
+--online-only` artifact instead — then there are no private sections.)
+
+## Why a Django app (not a static site)
+
+Parody artifact `html` is Django-template-flavored — it embeds `{% media %}`,
+`{% static %}`, `{% cite %}` etc. This app renders it **natively** through the
+Django template engine (`parody_web.templatetags.parody_web.render_book`), so
+there's no second, lossy tag-resolution renderer to maintain.
+
+## Use it in a project
+
+```python
+# settings.py
+INSTALLED_APPS = [..., "parody_web"]
+BOOK_SLUG = "real-time-computing"     # which imported book is the site root
+```
+```python
+# urls.py
+urlpatterns = [path("", include("parody_web.urls")), ...]
+```
+```bash
+pip install parody-web
+python manage.py migrate
+python manage.py createsuperuser                       # the owner (only account)
+python manage.py import_artifact rtc.json --slug real-time-computing
+```
+
+Provides: `Book`/`Chapter`/`Section` models, the `import_artifact` command
+(upsert-by-slug, idempotent), index + section views, templates (override them in
+your project), and the rendering template tags. Reads `settings.BOOK_SLUG`,
+`MEDIA_URL`, `LOGIN_URL`.
+
+A ready-to-copy thin project — settings, urls, Procfile, and AWS/SSM deploy glue
+— lives in [`example_site/`](example_site/); generate a new book site from it.
+
+## Develop
+
+```bash
+pip install -e .
+python runtests.py            # standalone test suite (tests/settings.py)
+```
+
+## Deploy
+
+AWS via SSM + GitHub Actions, designed for **reuse across book projects**: each
+book site is a small repo (copied from `example_site/`) that pins this package
+and calls the shared reusable workflow (`deploy-reusable.yml`) — improve the
+renderer or the deploy once, every site picks it up. Runbook:
+[`example_site/deploy/AWS.md`](example_site/deploy/AWS.md).
+
+## Status
+
+`0.x` — interfaces may change. Renders the rtc artifact end to end with
+section-level auth gating; 9 tests. `{% cite %}` currently renders `[key]`
+(wire citeproc/a .bib for full citations). Not yet published to PyPI or
+deployed to rtcbook.org (owner steps).

parody_web-0.1.0/parody_web/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class ParodyWebConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "parody_web"
+    verbose_name = "Parody Web"

parody_web-0.1.0/parody_web/management/commands/import_artifact.py

@@ -0,0 +1,89 @@
+"""Import a parody artifact JSON into the book-host DB.
+
+Feed it the partial (``parody build --online-only``) artifact for a public
+copyright-restricted book: the full text never enters this database. Upsert by
+slug so re-imports are idempotent and stable.
+"""
+import json
+
+from django.core.management.base import BaseCommand, CommandError
+from django.db import transaction
+
+from parody_web.models import Book, Chapter, Section
+
+
+class Command(BaseCommand):
+    help = "Import a parody artifact JSON into the book-host database."
+
+    def add_arguments(self, parser):
+        parser.add_argument("artifact", help="path to the parody artifact JSON")
+        parser.add_argument(
+            "--slug", help="book slug (defaults to the artifact's slug or filename)"
+        )
+
+    def handle(self, *args, **opts):
+        path = opts["artifact"]
+        try:
+            with open(path, encoding="utf-8") as f:
+                data = json.load(f)
+        except (OSError, ValueError) as e:
+            raise CommandError(f"could not read artifact {path}: {e}")
+
+        version = data.get("schema_version", 0)
+        if not isinstance(version, int) or version < 2:
+            self.stderr.write(self.style.WARNING(
+                f"artifact schema_version {version!r}: this host targets v2 "
+                "(textbooks); importing what it can."))
+
+        slug = opts.get("slug") or data.get("slug") or path.rsplit("/", 1)[-1][:-5]
+
+        with transaction.atomic():
+            self._import(slug, data)
+
+    def _import(self, slug, data):
+        book, _ = Book.objects.update_or_create(slug=slug, defaults={
+            "title": data.get("title", slug),
+            "description": data.get("description", ""),
+            "authors": data.get("author", []),
+            "book_metadata": data.get("book"),
+            "videos": data.get("videos"),
+            "apocrypha": data.get("apocrypha"),
+            "source_commit": data.get("source_commit") or "",
+            "built_at": data.get("built_at") or "",
+        })
+
+        seen_ch, seen_sec = set(), set()
+        for ci, ch in enumerate(data.get("chapters", [])):
+            chapter, _ = Chapter.objects.update_or_create(
+                book=book, slug=ch["slug"], defaults={
+                    "title": ch.get("title", ""),
+                    "order": ci + 1,
+                    "hash": ch.get("hash", ""),
+                    "appendix": bool(ch.get("appendix", False)),
+                })
+            seen_ch.add(chapter.slug)
+            for si, sec in enumerate(ch.get("sections", [])):
+                Section.objects.update_or_create(
+                    book=book, chapter=chapter, slug=sec["slug"], defaults={
+                        "title": sec.get("title", ""),
+                        "order": si + 1,
+                        "hash": sec.get("hash", ""),
+                        "html": sec.get("html", ""),
+                        "online_resources": sec.get("online_resources", ""),
+                        "online_only": bool(sec.get("online_only", False)),
+                        "anchors": sec.get("anchors", []),
+                    })
+                seen_sec.add((chapter.slug, sec["slug"]))
+
+        # prune rows no longer in the artifact
+        for sec in book.sections.all():
+            if (sec.chapter.slug, sec.slug) not in seen_sec:
+                sec.delete()
+        for ch in book.chapters.all():
+            if ch.slug not in seen_ch:
+                ch.delete()
+
+        n_sec = book.sections.count()
+        self.stdout.write(self.style.SUCCESS(
+            f"imported '{book.title}' ({slug}): {book.chapters.count()} chapters, "
+            f"{n_sec} sections"))

parody_web-0.1.0/parody_web/migrations/0001_initial.py

@@ -0,0 +1,65 @@
+# Generated by Django 5.2.4 on 2026-06-15 17:59
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Book',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('slug', models.SlugField(unique=True)),
+                ('title', models.CharField(max_length=300)),
+                ('description', models.TextField(blank=True)),
+                ('authors', models.JSONField(blank=True, default=list)),
+                ('book_metadata', models.JSONField(blank=True, null=True)),
+                ('videos', models.JSONField(blank=True, null=True)),
+                ('apocrypha', models.JSONField(blank=True, null=True)),
+                ('source_commit', models.CharField(blank=True, max_length=64)),
+                ('built_at', models.CharField(blank=True, max_length=40)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='Chapter',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('slug', models.SlugField(max_length=120)),
+                ('title', models.CharField(max_length=300)),
+                ('order', models.PositiveIntegerField(default=0)),
+                ('hash', models.CharField(blank=True, default='', max_length=100)),
+                ('appendix', models.BooleanField(default=False)),
+                ('book', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='chapters', to='parody_web.book')),
+            ],
+            options={
+                'ordering': ['order'],
+                'unique_together': {('book', 'slug')},
+            },
+        ),
+        migrations.CreateModel(
+            name='Section',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('slug', models.SlugField(max_length=120)),
+                ('title', models.CharField(max_length=300)),
+                ('order', models.PositiveIntegerField(default=0)),
+                ('hash', models.CharField(blank=True, default='', max_length=100)),
+                ('html', models.TextField(blank=True)),
+                ('online_resources', models.TextField(blank=True)),
+                ('online_only', models.BooleanField(default=False)),
+                ('anchors', models.JSONField(blank=True, default=list)),
+                ('book', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='sections', to='parody_web.book')),
+                ('chapter', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='sections', to='parody_web.chapter')),
+            ],
+            options={
+                'ordering': ['order'],
+            },
+        ),
+    ]

parody_web-0.1.0/parody_web/models.py

@@ -0,0 +1,58 @@
+"""Models mirroring a parody schema-v2 artifact, slimmed for a public,
+read-only book site (no solution gating, enrollment, or annotations — those
+are ricopic.one concerns). A Book holds the bibliographic/web metadata; a
+Section stores the rendered (Django-template-flavored) html and any per-section
+online-resources addenda."""
+
+from django.db import models
+
+
+class Book(models.Model):
+    slug = models.SlugField(unique=True)
+    title = models.CharField(max_length=300)
+    description = models.TextField(blank=True)
+    authors = models.JSONField(default=list, blank=True)
+    # parody artifact top-level metadata (book-defs / videos / apocrypha)
+    book_metadata = models.JSONField(null=True, blank=True)
+    videos = models.JSONField(null=True, blank=True)
+    apocrypha = models.JSONField(null=True, blank=True)
+    source_commit = models.CharField(max_length=64, blank=True)
+    built_at = models.CharField(max_length=40, blank=True)
+
+    def __str__(self):
+        return self.title
+
+
+class Chapter(models.Model):
+    book = models.ForeignKey(Book, related_name="chapters", on_delete=models.CASCADE)
+    slug = models.SlugField(max_length=120)
+    title = models.CharField(max_length=300)
+    order = models.PositiveIntegerField(default=0)
+    hash = models.CharField(max_length=100, blank=True, default="")
+    appendix = models.BooleanField(default=False)
+
+    class Meta:
+        unique_together = ("book", "slug")
+        ordering = ["order"]
+
+    def __str__(self):
+        return f"{self.book.slug} – {self.title}"
+
+
+class Section(models.Model):
+    book = models.ForeignKey(Book, related_name="sections", on_delete=models.CASCADE)
+    chapter = models.ForeignKey(Chapter, related_name="sections", on_delete=models.CASCADE)
+    slug = models.SlugField(max_length=120)
+    title = models.CharField(max_length=300)
+    order = models.PositiveIntegerField(default=0)
+    hash = models.CharField(max_length=100, blank=True, default="")
+    html = models.TextField(blank=True)
+    online_resources = models.TextField(blank=True)
+    online_only = models.BooleanField(default=False)
+    anchors = models.JSONField(default=list, blank=True)
+
+    class Meta:
+        ordering = ["order"]
+
+    def __str__(self):
+        return f"{self.book.slug} – {self.title}"

parody_web-0.1.0/parody_web/templates/parody_web/base.html

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<title>{% block title %}{{ book.title }}{% endblock %}</title>
+<style>
+body { max-width: 46rem; margin: 2rem auto; padding: 0 1rem;
+       font: 1.05rem/1.6 Georgia, 'Times New Roman', serif; color: #1a1a1a; }
+nav.crumbs { font-family: system-ui, sans-serif; font-size: .85rem; margin-bottom: 2rem; }
+nav.pager { display: flex; justify-content: space-between;
+            font-family: system-ui, sans-serif; font-size: .9rem; margin-top: 3rem; }
+h1, h2, h3 { font-family: system-ui, sans-serif; line-height: 1.25; }
+img { max-width: 100%; }
+pre { background: #f6f6f4; padding: .8rem 1rem; overflow-x: auto; font-size: .85rem; }
+table { border-collapse: collapse; } th, td { border: 1px solid #ccc; padding: .3rem .6rem; }
+details { margin: .4rem 0; } summary { cursor: pointer; }
+.version-list-item { margin: .15rem 0 .15rem 1rem; font-size: .95rem; }
+section.online-resources { border-top: 1px solid #ddd; margin-top: 2.5rem; }
+.get-cell-placeholder { color: #999; }
+a.download-button { display: inline-block; font-family: system-ui, sans-serif;
+    font-size: .9rem; border: 1px solid #7a6ff0; border-radius: 4px;
+    padding: .25rem .7rem; text-decoration: none; }
+.note { color:#999; font-size:.8rem; }
+</style>
+<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js" async></script>
+</head>
+<body>
+<div style="font-family:system-ui,sans-serif;font-size:.8rem;text-align:right;color:#999">
+{% if user.is_authenticated %}
+  owner view ({{ user.get_username }}) ·
+  <form action="{% url 'logout' %}" method="post" style="display:inline">{% csrf_token %}<button type="submit" style="border:none;background:none;color:#7a6ff0;cursor:pointer;font:inherit;padding:0">sign out</button></form>
+{% else %}
+  <a href="{% url 'login' %}">owner sign in</a>
+{% endif %}
+</div>
+{% block body %}{% endblock %}
+</body>
+</html>

parody_web-0.1.0/parody_web/templates/parody_web/index.html

@@ -0,0 +1,31 @@
+{% extends "parody_web/base.html" %}
+{% block body %}
+<h1>{{ book.title }}</h1>
+{% if book.authors %}<p><em>{{ book.authors|join:", " }}</em></p>{% endif %}
+{% if book.description %}<p>{{ book.description }}</p>{% endif %}
+{% if book.book_metadata.editions %}
+  <p class="note">
+  {% with ed=book.book_metadata.editions.0 %}
+    {% if ed.publisher %}{{ ed.publisher }}{% endif %}
+    {% if ed.year %}({{ ed.year }}){% endif %}
+    {% if ed.isbn %}· ISBN {{ ed.isbn }}{% endif %}
+  {% endwith %}
+  {% if book.book_metadata.companion_url %}
+    · <a href="{{ book.book_metadata.companion_url }}">companion</a>{% endif %}
+  </p>
+{% endif %}
+
+{% for chapter, sections in chapters %}
+  <h2>{{ chapter.title }}{% if chapter.appendix %} <span class="note">(appendix)</span>{% endif %}</h2>
+  <ul>
+  {% for section in sections %}
+    <li><a href="{% url 'parody_web:section' chapter.slug section.slug %}">{{ section.title }}</a>
+      {% if not section.online_only and section.online_resources %}<span class="note">— online resources</span>{% endif %}
+    </li>
+  {% endfor %}
+  </ul>
+{% endfor %}
+
+<p class="note">A partial web edition. Published from a parody artifact
+{% if book.built_at %}({{ book.built_at }}){% endif %}.</p>
+{% endblock %}

parody_web-0.1.0/parody_web/templates/parody_web/section.html

@@ -0,0 +1,25 @@
+{% extends "parody_web/base.html" %}
+{% load parody_web %}
+{% block title %}{{ section.title }} — {{ book.title }}{% endblock %}
+{% block body %}
+<nav class="crumbs"><a href="{% url 'parody_web:index' %}">{{ book.title }}</a>
+  › {{ chapter.title }}</nav>
+
+<h1>{{ section.title }}</h1>
+
+{% if section.html %}
+  {{ section.html|render_book }}
+{% endif %}
+
+{% if section.online_resources %}
+  <section class="online-resources">
+    <h2>Online resources</h2>
+    {{ section.online_resources|render_book }}
+  </section>
+{% endif %}
+
+<nav class="pager">
+  {% if prev %}<a href="{% url 'parody_web:section' prev.chapter.slug prev.slug %}">← {{ prev.title }}</a>{% else %}<span></span>{% endif %}
+  {% if next %}<a href="{% url 'parody_web:section' next.chapter.slug next.slug %}">{{ next.title }} →</a>{% else %}<span></span>{% endif %}
+</nav>
+{% endblock %}

parody_web-0.1.0/parody_web/templates/registration/login.html

@@ -0,0 +1,15 @@
+{% extends "parody_web/base.html" %}
+{% block title %}Sign in{% endblock %}
+{% block body %}
+<h1>Sign in</h1>
+<p class="note">The full book is available to the owner. The public edition
+shows only the openly-licensed sections.</p>
+{% if form.errors %}<p style="color:#b00">Incorrect username or password.</p>{% endif %}
+<form method="post">
+  {% csrf_token %}
+  <p><label>Username <input type="text" name="username" autofocus></label></p>
+  <p><label>Password <input type="password" name="password"></label></p>
+  <input type="hidden" name="next" value="{{ next }}">
+  <p><button type="submit">Sign in</button></p>
+</form>
+{% endblock %}

parody_web-0.1.0/parody_web/templatetags/parody_web.py

@@ -0,0 +1,85 @@
+"""Template tags that render parody's Django-template-flavored section html.
+
+The artifact's ``html`` embeds ``{% media %}``, ``{% static %}``, ``{% cite %}``
+etc. — the same tags ricopic.one resolves at view time. We resolve them here so
+the book-host renders the stored html natively (no lossy regex re-resolution).
+
+The ``render_book`` filter compiles a stored html blob as a Django template
+with this library loaded and renders it; ``{% csrf_token %}`` is stripped first
+(server-form-only, and it collides with the builtin), and a malformed tag
+degrades to escaped output rather than 500-ing the page.
+"""
+import re
+
+from django import template
+from django.conf import settings
+from django.template import Context, Template, TemplateSyntaxError
+from django.utils.html import conditional_escape
+from django.utils.safestring import mark_safe
+
+register = template.Library()
+
+
+@register.simple_tag
+def media(path):
+    return settings.MEDIA_URL + str(path).lstrip("/")
+
+
+@register.simple_tag
+def static(path):
+    return settings.STATIC_URL + str(path).lstrip("/")
+
+
+def _cite(key):
+    return mark_safe(f'<span class="citation">[{conditional_escape(key)}]</span>')
+
+
+@register.simple_tag
+def cite(key, *args, **kwargs):
+    return _cite(key)
+
+
+@register.simple_tag
+def cite_many(*keys, **kwargs):
+    return mark_safe("; ".join(_cite(k) for k in keys))
+
+
+@register.simple_tag
+def url(*args, **kwargs):
+    # server-side routes don't exist on the standalone book site
+    return "#"
+
+
+@register.simple_tag
+def get_cell(*args, **kwargs):
+    return mark_safe(
+        '<span class="get-cell-placeholder" '
+        'title="interactive table cell (site-only feature)">—</span>'
+    )
+
+
+@register.simple_tag
+def auth_button(*args, href="", label="Download", **kwargs):
+    return mark_safe(
+        f'<a class="download-button" href="{media(href)}">'
+        f"{conditional_escape(label)}</a>"
+    )
+
+
+_CSRF_RE = re.compile(r"\{%\s*csrf_token\s*%\}")
+
+
+@register.filter(is_safe=True)
+def render_book(html):
+    """Render stored Django-flavored html (defaults to '' for empty fields)."""
+    if not html:
+        return ""
+    source = "{% load parody_web %}" + _CSRF_RE.sub("", html)
+    try:
+        return mark_safe(Template(source).render(Context({})))
+    except TemplateSyntaxError as exc:
+        # Don't take the page down over one unexpected tag; surface in a comment.
+        return mark_safe(
+            f"<!-- book-host: unresolved template content: "
+            f"{conditional_escape(str(exc))} -->" + html
+        )

parody_web-0.1.0/parody_web/tests.py

@@ -0,0 +1,106 @@
+"""Book-host: artifact import, native Django rendering, and auth gating.
+
+The host imports the FULL artifact; the public sees only online-only sections,
+the private parts are gated behind login (only the owner has an account)."""
+import json
+import tempfile
+from pathlib import Path
+
+from django.contrib.auth import get_user_model
+from django.core.management import call_command
+from django.test import Client, TestCase, override_settings
+
+from parody_web.models import Book, Section
+from parody_web.templatetags.parody_web import render_book
+
+ARTIFACT = {
+    "schema_version": 2,
+    "slug": "demo-book",
+    "title": "Demo Book",
+    "author": ["A. Author"],
+    "book": {"name": "Demo", "editions": [{"id": "0", "isbn": "978-test"}]},
+    "chapters": [{
+        "title": "Hardware", "slug": "hardware", "hash": "h1",
+        "sections": [
+            {"title": "Specific T1 (public)", "slug": "specific-t1", "hash": "ef",
+             "online_only": True,
+             "html": '<p>The myRIO via {% media \'notebooks/x.jpg\' %}.</p>'
+                     '<details><summary>Specs</summary>'
+                     '<div class="version-list-item">SoC: Xilinx</div></details>',
+             "online_resources": '<p>Extra: {% cite \'knuth1997\' %}.</p>'},
+            {"title": "Licensed Chapter (private)", "slug": "licensed", "hash": "lz",
+             "html": "<p>Copyrighted prose.</p>"},
+        ],
+    }],
+}
+
+
+def _import(slug="demo-book"):
+    with tempfile.TemporaryDirectory() as d:
+        p = Path(d, "a.json")
+        p.write_text(json.dumps(ARTIFACT))
+        call_command("import_artifact", str(p), "--slug", slug)
+
+
+class RenderBookFilterTests(TestCase):
+    def test_resolves_media_and_strips_unknown(self):
+        out = render_book("<img src=\"{% media 'a/b.png' %}\"> {% csrf_token %}")
+        self.assertIn("/media/a/b.png", out)
+        self.assertNotIn("{%", out)
+
+    def test_cite_and_details_pass_through(self):
+        out = render_book("{% cite 'k' %} <details><summary>s</summary>x</details>")
+        self.assertIn('class="citation"', out)
+        self.assertIn("<details>", out)
+
+
+@override_settings(BOOK_SLUG="demo-book")
+class BookHostGatingTests(TestCase):
+    def setUp(self):
+        _import()
+        self.owner = get_user_model().objects.create_superuser(
+            "owner", "owner@example.com", "pw")
+        self.anon = Client()
+        self.signed_in = Client()
+        self.signed_in.force_login(self.owner)
+
+    def test_import_stored_fields(self):
+        book = Book.objects.get(slug="demo-book")
+        self.assertEqual(book.book_metadata["editions"][0]["isbn"], "978-test")
+        self.assertTrue(Section.objects.get(slug="specific-t1").online_only)
+        self.assertFalse(Section.objects.get(slug="licensed").online_only)
+
+    def test_public_index_lists_only_online_only(self):
+        r = self.anon.get("/")
+        self.assertEqual(r.status_code, 200)
+        self.assertContains(r, "Specific T1 (public)")
+        self.assertNotContains(r, "Licensed Chapter (private)")
+
+    def test_owner_index_lists_everything(self):
+        r = self.signed_in.get("/")
+        self.assertContains(r, "Specific T1 (public)")
+        self.assertContains(r, "Licensed Chapter (private)")
+
+    def test_public_section_renders_with_tags_resolved(self):
+        r = self.anon.get("/hardware/specific-t1/")
+        self.assertEqual(r.status_code, 200)
+        html = r.content.decode()
+        self.assertIn("/media/notebooks/x.jpg", html)
+        self.assertNotIn("{%", html)
+        self.assertIn("<details>", html)
+        self.assertIn("Online resources", html)  # online_resources rendered
+
+    def test_private_section_redirects_anonymous_to_login(self):
+        r = self.anon.get("/hardware/licensed/")
+        self.assertEqual(r.status_code, 302)
+        self.assertIn("/accounts/login", r["Location"])
+
+    def test_owner_sees_private_section(self):
+        r = self.signed_in.get("/hardware/licensed/")
+        self.assertEqual(r.status_code, 200)
+        self.assertContains(r, "Copyrighted prose")
+
+    def test_reimport_is_idempotent(self):
+        before = Section.objects.count()
+        _import()
+        self.assertEqual(Section.objects.count(), before)

parody_web-0.1.0/parody_web/urls.py

@@ -0,0 +1,11 @@
+from django.urls import path
+
+from . import views
+
+app_name = "parody_web"
+
+urlpatterns = [
+    path("", views.index, name="index"),
+    path("<slug:chapter_slug>/<slug:section_slug>/", views.section_detail,
+         name="section"),
+]

parody_web-0.1.0/parody_web/views.py

@@ -0,0 +1,63 @@
+"""Views for the book site.
+
+Public visitors see only the online-only sections (the licensed public subset);
+the private parts of the book are gated behind login — only the owner has an
+account. This lets one deployment hold the full artifact yet expose only the
+permitted subset publicly.
+"""
+
+from django.conf import settings
+from django.contrib.auth.views import redirect_to_login
+from django.http import Http404
+from django.shortcuts import get_object_or_404, render
+
+from .models import Book, Section
+
+
+def _current_book():
+    if getattr(settings, "BOOK_SLUG", ""):
+        return get_object_or_404(Book, slug=getattr(settings, "BOOK_SLUG", ""))
+    book = Book.objects.first()
+    if book is None:
+        raise Http404("no book imported")
+    return book
+
+
+def _visible_sections(book, user):
+    """All sections for the owner; only online-only for the public."""
+    qs = Section.objects.filter(book=book).select_related("chapter")
+    if not user.is_authenticated:
+        qs = qs.filter(online_only=True)
+    return list(qs)
+
+
+def index(request):
+    book = _current_book()
+    public = not request.user.is_authenticated
+    chapters = []
+    for ch in book.chapters.all():
+        sections = list(ch.sections.all())
+        if public:
+            sections = [s for s in sections if s.online_only]
+        if sections:
+            chapters.append((ch, sections))
+    return render(request, "parody_web/index.html", {
+        "book": book, "chapters": chapters, "public": public})
+
+
+def section_detail(request, chapter_slug, section_slug):
+    book = _current_book()
+    section = get_object_or_404(
+        Section, book=book, chapter__slug=chapter_slug, slug=section_slug)
+    # private (non-online-only) sections are owner-only
+    if not section.online_only and not request.user.is_authenticated:
+        return redirect_to_login(request.get_full_path())
+
+    flat = _visible_sections(book, request.user)
+    idx = next((i for i, s in enumerate(flat) if s.pk == section.pk), None)
+    prev_s = flat[idx - 1] if idx else None
+    next_s = flat[idx + 1] if idx is not None and idx + 1 < len(flat) else None
+    return render(request, "parody_web/section.html", {
+        "book": book, "section": section, "chapter": section.chapter,
+        "prev": prev_s, "next": next_s,
+    })

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

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: parody-web
+Version: 0.1.0
+Summary: Django app that serves a parody build artifact as a public book site, with section-level auth gating (public = online-only subset; owner = full book).
+Author-email: Rico Picone <dr@ricopic.one>
+License: MIT
+Project-URL: Homepage, https://github.com/ricopicone/parody-web
+Project-URL: Issues, https://github.com/ricopicone/parody-web/issues
+Keywords: parody,django,publishing,book,textbook
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: Django<6.0,>=5.0
+
+# parody-web
+
+A reusable **Django app** that serves a [parody](https://github.com/ricopicone/parody)
+build artifact as a public book site, with section-level auth gating. It's the
+*web* surface of the parody ecosystem:
+
+- **`parody`** — core: builds the artifact (and the print/LaTeX side, for now)
+- **`parody-web`** — *this*: renders an artifact as a website
+- *(future)* `parody-print` — if/when the LaTeX side is split out of core
+
+You `pip install parody-web` into a thin per-book Django project; the package is
+generic, so one codebase serves every book site. Each book differs only by
+config + content. First site: the partial *Real-Time Computing* book at
+[rtcbook.org](https://rtcbook.org).
+
+## Access model
+
+The site imports the **full** artifact and gates by section: the public sees
+only `online_only` sections (the openly-licensed subset); the **private** parts
+require login, and only the owner has an account. One deployment serves both the
+public partial book and — to the owner — the whole thing. (If you'd rather the
+full text never touch the database, import the partial `parody build
+--online-only` artifact instead — then there are no private sections.)
+
+## Why a Django app (not a static site)
+
+Parody artifact `html` is Django-template-flavored — it embeds `{% media %}`,
+`{% static %}`, `{% cite %}` etc. This app renders it **natively** through the
+Django template engine (`parody_web.templatetags.parody_web.render_book`), so
+there's no second, lossy tag-resolution renderer to maintain.
+
+## Use it in a project
+
+```python
+# settings.py
+INSTALLED_APPS = [..., "parody_web"]
+BOOK_SLUG = "real-time-computing"     # which imported book is the site root
+```
+```python
+# urls.py
+urlpatterns = [path("", include("parody_web.urls")), ...]
+```
+```bash
+pip install parody-web
+python manage.py migrate
+python manage.py createsuperuser                       # the owner (only account)
+python manage.py import_artifact rtc.json --slug real-time-computing
+```
+
+Provides: `Book`/`Chapter`/`Section` models, the `import_artifact` command
+(upsert-by-slug, idempotent), index + section views, templates (override them in
+your project), and the rendering template tags. Reads `settings.BOOK_SLUG`,
+`MEDIA_URL`, `LOGIN_URL`.
+
+A ready-to-copy thin project — settings, urls, Procfile, and AWS/SSM deploy glue
+— lives in [`example_site/`](example_site/); generate a new book site from it.
+
+## Develop
+
+```bash
+pip install -e .
+python runtests.py            # standalone test suite (tests/settings.py)
+```
+
+## Deploy
+
+AWS via SSM + GitHub Actions, designed for **reuse across book projects**: each
+book site is a small repo (copied from `example_site/`) that pins this package
+and calls the shared reusable workflow (`deploy-reusable.yml`) — improve the
+renderer or the deploy once, every site picks it up. Runbook:
+[`example_site/deploy/AWS.md`](example_site/deploy/AWS.md).
+
+## Status
+
+`0.x` — interfaces may change. Renders the rtc artifact end to end with
+section-level auth gating; 9 tests. `{% cite %}` currently renders `[key]`
+(wire citeproc/a .bib for full citations). Not yet published to PyPI or
+deployed to rtcbook.org (owner steps).

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

@@ -0,0 +1,24 @@
+README.md
+pyproject.toml
+parody_web/__init__.py
+parody_web/apps.py
+parody_web/models.py
+parody_web/tests.py
+parody_web/urls.py
+parody_web/views.py
+parody_web.egg-info/PKG-INFO
+parody_web.egg-info/SOURCES.txt
+parody_web.egg-info/dependency_links.txt
+parody_web.egg-info/requires.txt
+parody_web.egg-info/top_level.txt
+parody_web/management/__init__.py
+parody_web/management/commands/__init__.py
+parody_web/management/commands/import_artifact.py
+parody_web/migrations/0001_initial.py
+parody_web/migrations/__init__.py
+parody_web/templates/parody_web/base.html
+parody_web/templates/parody_web/index.html
+parody_web/templates/parody_web/section.html
+parody_web/templates/registration/login.html
+parody_web/templatetags/__init__.py
+parody_web/templatetags/parody_web.py

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1 @@
+Django<6.0,>=5.0

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

@@ -0,0 +1 @@
+parody_web

parody_web-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "parody-web"
+version = "0.1.0"
+description = "Django app that serves a parody build artifact as a public book site, with section-level auth gating (public = online-only subset; owner = full book)."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+authors = [{ name = "Rico Picone", email = "dr@ricopic.one" }]
+keywords = ["parody", "django", "publishing", "book", "textbook"]
+classifiers = [
+  "Framework :: Django",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Development Status :: 3 - Alpha",
+]
+dependencies = ["Django>=5.0,<6.0"]
+
+[project.urls]
+Homepage = "https://github.com/ricopicone/parody-web"
+Issues = "https://github.com/ricopicone/parody-web/issues"
+
+[tool.setuptools.packages.find]
+include = ["parody_web*"]
+
+[tool.setuptools.package-data]
+parody_web = ["templates/parody_web/*.html", "templates/registration/*.html"]

parody_web-0.1.0/setup.cfg

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