parody
A play on parity: keeping the print and web versions of a work in parity.
One authoring toolchain for books and course notebooks: pandoc markdown (with executed jupytext code cells) in, multiple targets out —
- JSON artifact (schema-versioned; the contract consumed by ricopic.one's Django importer and other tools)
- standalone HTML preview (no server needed; resolves the artifact's site-template tags itself)
- print-quality PDF via LaTeX profiles (lualatex/latexmk; generic profile bundled, book-private profiles pluggable)
Parody unifies and replaces the toolchains of two ancestor systems: the
homepage-django notebooks pipeline and the rtc-book meta-* book machinery.
See NEW_PROJECT_SEED_PLAN.md for the full plan.
Install / develop
Requires Python ≥ 3.11 and pandoc (pinned version in
parody/toolchain.py), or use the Dockerfile/devcontainer.
uv sync # create venv + install
uv run parody --help
uv run pytest # golden tests need the ancestor corpora; see tests/golden/
CLI
parody init <dir> # scaffold a content repo (incl. CI workflow)
parody build <project_dir> <output.json> [--clozes blank|key|full] # JSON artifact
parody preview <project_dir> -o preview # static HTML site for review
parody watch <project_dir> # rebuild on save (pip install 'parody[watch]')
parody pdf <project_dir> [--solutions] [--clozes MODE] [--section ch/sec] # print PDF (needs TeX)
parody check <artifact.json> # validate artifact against schema
parody check --toolchain # verify pinned toolchain versions
Content repos use parody.yaml + chapters/<ch>/<sec>.md; the legacy
System A layout (__meta.yaml + chapter_*/) builds bit-compatibly and
remains covered by golden tests.
Fill-in-the-blank (cloze) content
[answer]{.cloze} hides text behind a blank sized to it; []{.blank size=lg}
is an empty blank with nothing behind it (sm/md/lg/xl = 2/5/10/20 em, or
width=4cm). Block forms: ::: {.blank lines=6} for work space, ::: {.cloze}
for a hidden passage. Inside math, use the macros — a span cannot live inside
$…$: $\tau = \cloze{RC}$, $y = \clozeblank{3em}$. A figure can carry
incomplete artwork with cloze="fig-blank.pdf", or by putting a
<stem>-cloze.<ext> sibling next to it.
Three build modes, set by --clozes (or cloze: {default: …} in
parody.yaml), independent of --solutions:
| mode | who it is for |
|---|---|
blank (default) |
student handout — answers replaced by rules at build time |
key |
instructor copy — answers shown, accented |
full |
publication — answers as ordinary text, blanks dropped entirely |
parody pdf . --clozes blank
parody build . artifact/book-full.json --clozes full
In blank mode the answer never reaches the browser or the PDF content stream —
it is removed at build time, not hidden with CSS. Print measures the real box
with \settowidth, so widths are exact; the web estimates from character count.
A cloze inside an exercise solution always renders full.
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-0.34.1.tar.gz.
File metadata
- Download URL: parody-0.34.1.tar.gz
- Upload date:
- Size: 1.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a8fca471b97b2eff6c453cb3de120488c7eabe37a3bfb5b1079dbe3b1ab70903
|
|
| MD5 |
38cd2f876f9713830aae71d00e0961e3
|
|
| BLAKE2b-256 |
1bd72c7f31ce6522389642702ed191698c1469a679d52d6970f206236776390c
|
File details
Details for the file parody-0.34.1-py3-none-any.whl.
File metadata
- Download URL: parody-0.34.1-py3-none-any.whl
- Upload date:
- Size: 192.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
761567e196bb688513810c888a3304e6c4a6e76f9f8652f8b4b09dc052816b5a
|
|
| MD5 |
8918bede3e128b141c98c02be68a3bd2
|
|
| BLAKE2b-256 |
70c22d1bd418b617522b4df720b6d1973f3a9ad0745ede5b175282760f593016
|
