parody-web
A reusable Django app that serves a 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.
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
# settings.py
INSTALLED_APPS = [..., "parody_web"]
BOOK_SLUG = "real-time-computing" # which imported book is the site root
# urls.py
urlpatterns = [path("", include("parody_web.urls")), ...]
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/; generate a new book site from it.
Data-entry tables
A lab manual authors an observation table as ::: {.editable-table}. On the
site a signed-in reader types their readings into it, Save keeps them, and
they are still there next visit. A reader who is not signed in sees the table
with its inputs disabled and a line saying why.
Download JSON gives back that one table; All my tables (/tables.json)
gives every table in the book the reader has put something in — a term's
measurements in one file instead of a scavenger hunt through a dozen labs.
The file is the table as it appears on the page: a columns header row, and
rows as one flat record per row keyed by those headers, including the column
the row labels live in. Empty cells are "" rather than missing, so a
half-filled table still loads as a table:
import json, pandas as pd
d = json.load(open("mechatronics-lab-manual-lab-test-observations.json"))
df = pd.DataFrame(d["rows"], columns=d["columns"])
Each file also carries which book, which section (title, number and URL) and
when it was exported, and names its shape in format (parody-table/1,
parody-tables/1) so a later change to that shape is a new number rather than
a silent break.
Values are stored per cell, keyed to the reader and to Section.key rather
than to a row that re-import would delete — a term's measurements outlive the
book being rebuilt. Nothing is needed from the host but migrate.
Serving a book from your own project
A host project (a course site, say) can serve a parody book while keeping its
own readers, gating, and per-user features. See
Host integration for the four seams: imported
per-exercise solutions/problems, the pluggable access policy
(PARODY_WEB_ACCESS_POLICY), the per-user overlay include points, and the
Section.key join key.
Develop
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.
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).
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file parody_web-0.74.0.tar.gz.
File metadata
- Download URL: parody_web-0.74.0.tar.gz
- Upload date:
- Size: 1.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ef55debfe017490b6c57c4a986694aea76713715a9759abf36c9a0edd277344b
|
|
| MD5 |
4f8b3a2f2d61439185fcbd4bebfaf357
|
|
| BLAKE2b-256 |
3ab35a89eb65a6c55694b3f5127740d0c692067f50a9e5714dffcba8b545eb6a
|
File details
Details for the file parody_web-0.74.0-py3-none-any.whl.
File metadata
- Download URL: parody_web-0.74.0-py3-none-any.whl
- Upload date:
- Size: 1.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7d3b12025195da8c78ede66eac397ba4f6e65b1fefdc118d65ec5b4490dfb0dc
|
|
| MD5 |
702e1065a3a7ddfe3c83005d5c8248d0
|
|
| BLAKE2b-256 |
2cdc0199a0b519d97ce5136223d8f2cb3eac61c3390edd454b7b67dcb19aae4f
|
