Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

🎓 quarto-coursegen


A CLI tool that scaffolds Quarto course websites from a single course.yaml definition file.

✨ Features

  • Single source of truth — define your entire course (modules, artifacts, schedule, instructors) in one course.yaml file
  • Two-stage pipeline — separate generation (scaffold .qmd stubs + Quarto config) from rendering (Quarto → HTML/PDF)
  • Multiple output formats — reveal.js slides, Beamer PDF, HTML handouts, PDF assignments, and a full course website from the same source
  • Smart overwrite policy — stubs are never overwritten after the first run; navigation and sub-project configs are always kept up to date
  • Customisable templates — override any built-in Jinja2 template locally without forking the tool
  • i18n support — UI strings and labels are externalised in lang/*.yaml (English and German included)
  • init command — bootstraps a ready-to-use course repo with a sensible directory structure in one step

📦 Installation

Requires Python ≥ 3.11.

pip install quarto-coursegen

Or with uv:

uv tool install quarto-coursegen

🚀 Quick Start

# 1. Create and bootstrap a new course project
quarto-coursegen init my-course
cd my-course

# 2. Edit course.yaml (title, modules, artifacts, instructors, …)

# 3. Scaffold .qmd stubs and Quarto config from course.yaml
quarto-coursegen generate

# 4. Fill in content in the generated .qmd files

# 5. Render with Quarto
quarto render          # course website → docs/
make slides            # reveal.js + Beamer PDF → docs/slides/
make handouts          # PDF handouts → docs/handouts/

For the full reference — course.yaml schema, command options, templates, i18n, rendering guide, Python API — see the documentation.

📁 Project layout (generated course repo)

course-repo/
│  ← quarto-coursegen init
├── course.yaml               ← edit this: title, modules, artifacts
├── Makefile                  ← rendering targets (make website / slides / …)
├── assets/
│   └── styles/
├── templates/                ← built-in Jinja2 templates (customise locally)
├── lang/                     ← built-in language files (customise locally)
│
│  ← optional
├── coursegen.yaml            ← tool config (overrides)
│
│  ← quarto-coursegen generate
├── _quarto.yml               ← generated once, then hand-editable
├── _quarto-nav.yml           ← always regenerated
├── _quarto-format.yml        ← always regenerated
├── index.qmd                 ← generated once, then hand-editable
└── content/
    ├── modules/
    ├── slides/
    ├── handouts/
    ├── notes/
    ├── assignments/
    └── syllabus.qmd

🧑‍💻 Development

git clone https://github.com/xylomorph/quarto-coursegen.git
cd quarto-coursegen
uv sync --dev
uv run pytest

🛠️ Tech Stack

Layer Technology
Language Python ≥ 3.11
CLI framework Typer
Templating Jinja2
Config parsing PyYAML + Pydantic
Output formatting Rich
Publishing Quarto
Package manager uv
Testing pytest

📚 Building the documentation

quarto render docs_src/      # output → docs/

🗂️ Package layout

src/quarto_coursegen/
├── cli.py            ← Typer app (init, generate commands)
├── config.py         ← CoursegenConfig, resolve_config, i18n loading
├── core.py           ← pure logic (normalize, resolve, collect)
├── env.py            ← Jinja2 environment factory
├── generators.py     ← generate() and per-file generator functions
├── initializer.py    ← init_project()
├── writer.py         ← write_file() with Rich output
└── package_data/
    ├── skeleton/     ← files copied by init (course.yaml, Makefile, …)
    ├── templates/    ← built-in Jinja2 templates
    └── lang/         ← built-in i18n files

Metadata

Release files for quarto-coursegen 0.1.0b3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for quarto-coursegen 0.1.0b3
File Size Uploaded Provenance Actions
quarto_coursegen-0.1.0b3.tar.gz 546.6 kB Without provenance Details for quarto_coursegen-0.1.0b3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for quarto-coursegen 0.1.0b3
File Interpreter ABI Platform Actions
quarto_coursegen-0.1.0b3-py3-none-any.whl Python 3 none any Details for quarto_coursegen-0.1.0b3-py3-none-any.whl

Total release size: 579.7 kB

Release files / quarto_coursegen-0.1.0b3.tar.gz

Download URL quarto_coursegen-0.1.0b3.tar.gz
Size 546.6 kB
Tags Source
SHA-256 checksum
How to use checksums
1481411750a7235378b891561209635363421b4552b472a294814225fb862f43
BLAKE2b-256 checksum
How to use checksums
a04f320e75bb23b4f34e850bd51997a0fd4f66e940f265282e1fcb93a343ee83
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Release files / quarto_coursegen-0.1.0b3-py3-none-any.whl

Download URL quarto_coursegen-0.1.0b3-py3-none-any.whl
Size 33.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0bc0cfa0ae3823972aab336b8c1a1d693b17d5795dfab189e67630857969ff73
BLAKE2b-256 checksum
How to use checksums
335ad961edd7e3cd0cb24f18d77c124443e08e5ab1ea8a22429d4c3eb13877aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.8

Security for quarto-coursegen 0.1.0b3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page