Skip to main content

Unified book/notebook authoring toolchain: pandoc markdown + executed jupytext sources to JSON artifact, HTML preview, and print PDF

Project description

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>   # build the JSON artifact (executes code)
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] [--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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

parody-0.8.0.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

parody-0.8.0-py3-none-any.whl (141.1 kB view details)

Uploaded Python 3

File details

Details for the file parody-0.8.0.tar.gz.

File metadata

  • Download URL: parody-0.8.0.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for parody-0.8.0.tar.gz
Algorithm Hash digest
SHA256 8e198aa72c6b646eed0b823214346063c86159050a5f722efb7be4a1bcfad621
MD5 8fd7ccb9e366d9b2d146f03fe8e4c8c6
BLAKE2b-256 a6fbf1ec226616265e041efe197eafdecea4ae159dc46f9bc0a2c650ce225ecb

See more details on using hashes here.

File details

Details for the file parody-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: parody-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 141.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for parody-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0d6e5e6544b1f2334deea7f225f0792dce455477a62fb0efa09f0ab84fbd7af2
MD5 e6766b250fc629be4ea175e7fa96c478
BLAKE2b-256 00cf96aec486ec3cbdf89c46a41fb2520d38c6566a4fc81ff1f99e167d968949

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page