Skip to main content

Coding-Academy Lecture Manager - A course content processing system

Project description

CLM - Coding-Academy Lecture Manager

CI codecov

Version: 1.0.0 | License: MIT | Python: 3.11, 3.12, 3.13

CLM is a course content processing system that converts educational materials (Jupyter notebooks, PlantUML diagrams, Draw.io diagrams) into multiple output formats.

Quick Start

Installation

# Install from PyPI
pip install coding-academy-lecture-manager

# Or with all optional dependencies (workers, TUI, web dashboard)
pip install "coding-academy-lecture-manager[all]"

For development, clone the repository and install in editable mode:

git clone https://github.com/hoelzl/clm.git
cd clm
pip install -e ".[all]"

Basic Usage

# Convert a course
clm build /path/to/course.xml

# Watch for changes and auto-rebuild
clm build /path/to/course.xml --watch

# Show help
clm --help

Features

  • Multiple Output Formats: HTML slides, Jupyter notebooks, PDF, extracted code
  • Multi-Language Notebooks: Python, C++, C#, Java, TypeScript
  • Diagram Support: PlantUML and Draw.io conversion
  • Multiple Output Targets: Separate student/solution/instructor outputs
  • Watch Mode: Auto-rebuild on file changes
  • Incremental Builds: Content-based caching

Documentation

For Users:

For Developers:

Development Setup

# Install pre-commit hooks (recommended)
uv run pre-commit install

# This enables automatic linting (ruff) and type checking (mypy) on every commit

Testing

# Run unit tests
pytest

# Run all tests (unit, integration, e2e)
pytest -m ""

# Run with coverage
pytest --cov=src/clm

License

MIT License - see LICENSE for details.

Links

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

coding_academy_lecture_manager-1.0.0.tar.gz (579.9 kB view details)

Uploaded Source

Built Distribution

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

coding_academy_lecture_manager-1.0.0-py3-none-any.whl (343.4 kB view details)

Uploaded Python 3

File details

Details for the file coding_academy_lecture_manager-1.0.0.tar.gz.

File metadata

  • Download URL: coding_academy_lecture_manager-1.0.0.tar.gz
  • Upload date:
  • Size: 579.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for coding_academy_lecture_manager-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c5a2f72f878a73a26a2a5325df0efd33d35b99d64fb4bbb868a92bb71d0269e0
MD5 ce774538857adf343322939d7ee23e13
BLAKE2b-256 b13ff8fe6083d2d6a7033ddfa03a8c7b8fb7b0f41c96d41366bccef537115f31

See more details on using hashes here.

File details

Details for the file coding_academy_lecture_manager-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: coding_academy_lecture_manager-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 343.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for coding_academy_lecture_manager-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4b51b1059154ca19681abba80c1aae8dcd9d371d9d528c2b3db56a841b8d4ba0
MD5 542e8411e4ecd62cd4e418433cb4be77
BLAKE2b-256 ca470c03ebce3378afb9b3d3bdaaa9b09b1a74b23146a0b8b5733f9a7470d9a3

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