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.2.tar.gz (897.0 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.2-py3-none-any.whl (133.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: parody-0.6.2.tar.gz
  • Upload date:
  • Size: 897.0 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.2.tar.gz
Algorithm Hash digest
SHA256 ef0a8835368ccc2b7ce8109e756ad42c8c7c1b2139f665db7d6400400c2a4cb5
MD5 f6bb3468791664ac864051e9a26633b5
BLAKE2b-256 bee345925dc787bb39edfa30f039ebf97937467fac64bf85d35639f2bb5687a4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: parody-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 133.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 97a23186ea0861d32e9eb2d5e8792fcbb618691578e7a31f6f92b0aa17700305
MD5 cc915a13d1db65dfa1e52d36ecfbf9f6
BLAKE2b-256 e45f68bbb0f0015b71090c1e3e5d2964bb0ba73272d27c8521aabfb8a20b12a0

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