How godanitt/cuadernos works
Cuadernos is both an open Typst library of subject notebooks and papers, and a Python manager for discovering, validating, compiling, and cataloging them. The main workflow is an editor or maintainer invoking the CLI: it discovers document metadata, validates selected sources, compiles them with Tinymist, and synchronizes catalog and paper outputs. The graph also preserves migration and source parsing as supporting capabilities. Some module relationships are evidenced by the source index rather than sampled call sites; unsampled implementation details are not inferred.
Main entry points: cli.py CLI commands · project.py Project discovery · build.py Incremental build · paper.py Paper model
Components 18
Command workflow
- CLI commands
src/cuadernos_manager/cli.py - Name migration
src/cuadernos_manager/migrate.py
Document model
- Project discovery
src/cuadernos_manager/project.py - Notebook model
src/cuadernos_manager/models.py - Paper model
src/cuadernos_manager/paper.py - Metadata reader
src/cuadernos_manager/metadata.py - Project settings
src/cuadernos_manager/settings.py - Typst parser
src/cuadernos_manager/parser.py - Notebook and paper sources
cuadernos
Build and quality
- Document validation
src/cuadernos_manager/validate.py - Incremental build
src/cuadernos_manager/build.py - Tinymist CLI
Catalog and outputs
- Catalog generation
src/cuadernos_manager/generate.py - Paper output sync
src/cuadernos_manager/paper.py - Compiled PDFs
pdf - Generated catalog
README.md - Paper PDFs
paper
Other components
- Maintainer
Connections 25
- Maintainer → CLI commands: invokes
README.md - CLI commands → Project discovery: discovers
src/cuadernos_manager/cli.py - CLI commands → Name migration: normalizes names
src/cuadernos_manager/cli.py - Project discovery → Notebook and paper sources: scans sources
src/cuadernos_manager/project.py - Project discovery → Notebook model: loads notebooks
src/cuadernos_manager/project.py - Project discovery → Paper model: loads papers
src/cuadernos_manager/project.py - Notebook model → Metadata reader: reads metadata
src/cuadernos_manager/models.py - Notebook model → Project settings: loads settings
src/cuadernos_manager/models.py - Paper model → Metadata reader: reads metadata
src/cuadernos_manager/paper.py - Paper model → Project settings: loads settings
src/cuadernos_manager/paper.py - CLI commands → Document validation: validates
src/cuadernos_manager/cli.py - Document validation → Typst parser: parses sources
src/cuadernos_manager/validate.py - Document validation → Metadata reader: checks metadata
src/cuadernos_manager/validate.py - CLI commands → Incremental build: builds documents
src/cuadernos_manager/cli.py - Incremental build → Tinymist CLI: runs compiler
src/cuadernos_manager/build.py - Incremental build → Compiled PDFs: writes notebooks
- Incremental build → Paper PDFs: writes papers
- CLI commands → Catalog generation: syncs catalog
src/cuadernos_manager/cli.py - Catalog generation → Typst parser: parses content
src/cuadernos_manager/generate.py - CLI commands → Paper output sync: syncs paper index
src/cuadernos_manager/cli.py - Paper output sync → Paper PDFs: lists outputs
src/cuadernos_manager/paper.py - Catalog generation → Generated catalog: writes catalog
- CLI commands → Paper model: selects papers
src/cuadernos_manager/cli.py - Name migration → Metadata reader: reads metadata
src/cuadernos_manager/migrate.py - Name migration → Project settings: loads settings
src/cuadernos_manager/migrate.py