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.1 | 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.1.tar.gz (607.0 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.1-py3-none-any.whl (363.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: coding_academy_lecture_manager-1.1.1.tar.gz
  • Upload date:
  • Size: 607.0 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.1.tar.gz
Algorithm Hash digest
SHA256 a9b6342095d9495f76efb8895017f750480387f46c74baf1e95b261081b91bdd
MD5 e8d5765691977e9a787aec949478af95
BLAKE2b-256 106c13002715c030c75d1a175e3988c08411ac447d9dd9fdcbb50ac2d0de207c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: coding_academy_lecture_manager-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 363.0 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3f85e1f1788a8fac9e2b039af3cfc7dd63461a71d8a1b5264594849ee93decf8
MD5 4ac0770f9b4491f8e0b574cd6dce595c
BLAKE2b-256 f9fbd5385e6eace48e09418bab4c62346d3742a9eb660cb8f3677536371b92bb

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