Skip to main content

Coding-Academy Lecture Manager - A course content processing system

Project description

CLM - Coding-Academy Lecture Manager

CI codecov

Version: 1.1.0 | License: MIT | Python: 3.11, 3.12, 3.13, 3.14

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, 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
  • Git Integration: Manage output repos with clm git init/sync/status
  • Flexible Remote URLs: Configurable git remote URL templates for SSH, custom hosts, etc.

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.1.0.tar.gz (604.8 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.1.0-py3-none-any.whl (362.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: coding_academy_lecture_manager-1.1.0.tar.gz
  • Upload date:
  • Size: 604.8 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.1.0.tar.gz
Algorithm Hash digest
SHA256 265d3898cf13d022718617c2f75c955aba342d40addfcf28c7f6b489d62e549c
MD5 113ce10e8d9ddfe3d6cba4acdd939e90
BLAKE2b-256 be57e58b7cfede6796a80ed78e10b9547a9a8804dc14df2fe557fa66ce3786c2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: coding_academy_lecture_manager-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 362.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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e563818ab134ae7da09384e955c694dffe61100308ffc6ade3fc8ebbdf4f47e
MD5 50634441d45e9b3bf3d955ad917ca97b
BLAKE2b-256 be7567f5650211beff18fe4ea84e9721ff75aac1e3b9b0d95d0c1c8be22ecbd6

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