cdl-slides 1.1.0__tar.gz

cdl_slides-1.1.0/.github/workflows/ci.yml

@@ -0,0 +1,91 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.11", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies (Linux)
+        if: runner.os == 'Linux'
+        run: ./scripts/install-system-deps.sh
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package
+        run: pip install -e ".[dev]"
+
+      - name: Run unit tests
+        run: pytest tests/ -v --tb=short
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install ruff
+        run: pip install ruff
+
+      - name: Run ruff check
+        run: ruff check src/ tests/
+
+      - name: Run ruff format check
+        run: ruff format --check src/ tests/
+
+  integration:
+    name: Integration test (with Marp CLI)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: ./scripts/install-system-deps.sh
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install Google Chrome
+        uses: browser-actions/setup-chrome@latest
+        with:
+          chrome-version: stable
+
+      - name: Install package and run setup
+        run: |
+          pip install -e .
+          cdl-slides setup
+
+      - name: Compile sample presentation (HTML)
+        run: cdl-slides compile examples/sample_presentation.md --format html --no-animations
+
+      - name: Verify HTML output exists
+        run: test -f examples/sample_presentation.html
+
+      - name: Compile sample presentation (PDF)
+        run: cdl-slides compile examples/sample_presentation.md --format pdf --no-animations
+
+      - name: Verify PDF output exists
+        run: test -f examples/sample_presentation.pdf

cdl_slides-1.1.0/.gitignore

@@ -0,0 +1,222 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# cdl-slides project-specific
+cdl-theme-*/
+.marp_processed_*.md
+*.marp_processed_*.md
+.sisyphus/
+notes/
+
+# Compiled example output (themes/images are copied during compile)
+examples/themes/
+examples/images/
+examples/*.html
+
+# macOS
+.DS_Store

cdl_slides-1.1.0/AGENTS.md

@@ -0,0 +1,105 @@
+# CDL-SLIDES KNOWLEDGE BASE
+
+**Generated:** 2026-02-06
+**Commit:** 6e9bc74
+**Branch:** main
+
+## OVERVIEW
+
+Python CLI tool that compiles Markdown into CDL-themed Marp presentations. Core stack: Click CLI, Pygments highlighting, optional Manim animations.
+
+## STRUCTURE
+
+```
+cdl-slides/
+├── src/cdl_slides/
+│   ├── cli.py              # Entry point (cdl-slides command)
+│   ├── preprocessor.py     # Main logic: flow diagrams, code splitting, animations
+│   ├── compiler.py         # Orchestrates Marp CLI execution
+│   ├── animate_parser.py   # DSL parser for ```animate blocks
+│   ├── animate_transpiler.py # Converts DSL AST to Manim Python
+│   ├── manim_renderer.py   # Executes Manim, generates GIFs
+│   └── assets/             # Bundled fonts, CSS, images
+├── tests/                  # Pytest suite (238 tests)
+└── examples/               # Sample presentations
+```
+
+## WHERE TO LOOK
+
+| Task | Location | Notes |
+|------|----------|-------|
+| Add CLI command | `cli.py` | Uses Click decorators |
+| Modify slide preprocessing | `preprocessor.py` | Battle-tested regexes - don't refactor |
+| Add DSL command | `animate_parser.py` + `animate_transpiler.py` | Add regex pattern + generation logic |
+| Fix animation rendering | `manim_renderer.py` | Handles GIF caching |
+| Update theme styles | `assets/themes/cdl-theme.css` | POSIX paths only |
+
+## CRITICAL: ANIMATE DSL USAGE
+
+**ALWAYS use the DSL markdown syntax for animations.** The DSL approach is preferred because it handles object creation and animation separation correctly, avoids Manim quirks, and produces cleaner, more maintainable code.
+
+**Escape hatch:** For complex animations not expressible in DSL, use `manim <python_code> as NAME` within an animate block. This is the ONLY acceptable way to use raw Manim code.
+
+### DSL Syntax (use this):
+```
+write equation "y = \sin(x)" as label
+fade-in label
+```
+
+### Supported DSL Commands:
+- `write equation "LATEX" as NAME [position]` - Create equation
+- `write text "string" as NAME [position]` - Create text
+- `create axes x=[min,max,step] y=[min,max,step] as NAME` - Coordinate system
+- `create graph "formula" x=[min,max] color=COLOR as NAME` - Standalone function graph
+- `plot "formula" on AXES color=COLOR stroke=N as NAME` - Plot on existing axes (stroke sets line width)
+- `create [circle|square|arrow] color=COLOR as NAME` - Shapes
+- `fade-in NAME` / `fade-out NAME` - Animations
+- `draw NAME` - Create animation (for axes/graphs)
+- `transform NAME1 -> NAME2` - Morph animation
+- `wait SECONDS` - Pause
+- `manim <python_code> as NAME` - Escape hatch for complex cases
+
+### Position Modifiers:
+- `at center`
+- `above/below/left-of/right-of REFERENCE`
+
+### Metadata (block header):
+- `height: 400`, `width: 600`, `quality: high`, `scale: 2.5`
+
+## ANTI-PATTERNS
+
+| Forbidden | Reason |
+|-----------|--------|
+| Mock objects in tests | Must use real files/calls for verification |
+| Refactoring preprocessor regexes | Battle-tested, port faithfully |
+| Adding manim to core deps | Animation support is optional |
+| External image references | All assets must be bundled |
+| Silently swallowing errors | Must produce warning-box in HTML output |
+| Using gifsicle | Use Pillow for GIF processing |
+
+## CONVENTIONS
+
+- **Line length**: 120 chars (Ruff)
+- **Python**: >=3.9
+- `preprocessor.py` ignores E501 (embedded templates)
+- Tests must be "real-world" - no mocks
+
+## COMMANDS
+
+```bash
+# Development
+pip install -e ".[dev,animations]"
+pytest tests/ -v
+ruff check src/ tests/ && ruff format src/ tests/
+
+# Usage
+cdl-slides compile slides.md --format html
+cdl-slides compile slides.md --format pdf
+```
+
+## NOTES
+
+- Animation support included by default with `pip install cdl-slides`
+- Marp CLI auto-downloads on first use
+- GIFs cached by content hash in output directory (e.g., `animations/` alongside slides)
+- Graceful degradation: missing manim shows warning-box, not crash

cdl_slides-1.1.0/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-02-06
+
+### Added
+
+- **Animate DSL**: Declarative syntax for creating Manim animations without writing Python code
+  - Object commands: `write equation`, `write text`, `create axes`, `create graph`, `plot`, `create circle/square/arrow`
+  - Animation commands: `fade-in`, `fade-out`, `draw`, `transform`, `wait`
+  - Position modifiers: `at center`, `above/below/left-of/right-of`
+  - Metadata options: `height`, `width`, `quality`, `scale`
+  - Escape hatch: `manim <python_code> as NAME` for complex animations
+- **Flow diagrams**: Simple ```` ```flow ```` syntax for pipeline diagrams with Dartmouth brand colors
+- **Smart preprocessing**: Auto-splits long code blocks and tables across slides
+- **Callout boxes**: Note, tip, warning, definition, example, and important box styles
+- **Two-column layouts**: Flexbox-based column layouts with callout box styling
+- **Scale directives**: Manual and automatic font scaling for dense slides
+- **Emoji figures**: Styled emoji icons with colored backgrounds
+- **Arrow syntax**: Shorthand for styled arrows (`--[80]->`, `--[lg]->`)
+- **Syntax highlighting**: Code blocks with line numbers via Pygments
+- **Math support**: KaTeX for inline and display equations
+- **Cross-platform Marp CLI**: Auto-downloads standalone binary on first use (macOS, Linux, Windows)
+- **Multiple output formats**: HTML, PDF, and PPTX
+
+### Features
+
+- Zero-config installation: `pip install cdl-slides` includes everything (Manim, FFmpeg, fonts)
+- Bundled fonts: Avenir LT Std, Fira Code, Noto Sans SC
+- Bundled ffmpeg via `imageio-ffmpeg` — no system installation required
+- GIF caching by content hash for fast re-compilation
+- Graceful degradation: animation errors show warning-box instead of crash
+
+### CLI Commands
+
+- `cdl-slides compile` — Compile Markdown to presentation
+- `cdl-slides init` — Create new presentation from template
+- `cdl-slides version` — Show version and Marp CLI status
+- `cdl-slides setup` — Pre-download Marp CLI binary
+
+[1.0.0]: https://github.com/ContextLab/cdl-slides/releases/tag/v1.0.0

cdl_slides-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Contextual Dynamics Laboratory
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.