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.3.0.tar.gz (2.5 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.3.0-py3-none-any.whl (75.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for parody-0.3.0.tar.gz
Algorithm Hash digest
SHA256 df6c9496924375aae5ec9dd1435c36b1dd489f71b11ea9da97efc5b7bc236fa7
MD5 5ee96f1dc7520d58fbbdab2a2067de23
BLAKE2b-256 f163ef892a765ab73dc284622ca9c7747b980b3178ce7ec4414095159b91a9ed

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for parody-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 969bdd7f6110ea129cd487f83091beb1e444e1b2ddcf1e310b8f67c9913f12dd
MD5 7497a664fb6b17fd9036ca24c6369bcd
BLAKE2b-256 67688b989b0c05e4db4c0c24feb3ad1cc9acc352db4ae6ae35eb4aa75b321cba

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