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.6.3.tar.gz (896.9 kB view details)

Uploaded Source

Built Distribution

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

parody-0.6.3-py3-none-any.whl (133.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for parody-0.6.3.tar.gz
Algorithm Hash digest
SHA256 e1cd5c887d4dae2cd750f33af07fe24e9f53bd3637f7c6d91de9b4fef077a7a4
MD5 730d7efacf31d44b6e4c3937db28598e
BLAKE2b-256 fd79eedb42b8b0063672ea3525d13ec84ce5ce14d6c9ef5736bb4d28c4836a58

See more details on using hashes here.

File details

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

File metadata

  • Download URL: parody-0.6.3-py3-none-any.whl
  • Upload date:
  • Size: 133.5 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.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f46f22e42a16262883d0e32fe1b768709c140a527710a3598f052cdb1bfedff7
MD5 d017ced633e6abae18185cb27904dd42
BLAKE2b-256 2806b7da4ac2c8c04bbf8a35987a5d43ee471c7831540c0044a7de2924a9b3ae

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