Metadata-Version: 2.4
Name: murali-kit
Version: 0.3.0
Summary: Free Python authoring kit and add-ons for Murali Engine.
Author: Murali Engine
License: MIT OR Apache-2.0
Project-URL: Homepage, https://github.com/murali-engine/murali-kit
Project-URL: Repository, https://github.com/murali-engine/murali-kit
Project-URL: Engine, https://github.com/murali-engine/murali
Keywords: animation,education,visualization,ai,math
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Education
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: murali-engine<0.4.0,>=0.3.0

# Murali Kit

Python authoring kit for [Murali Engine](https://github.com/murali-engine/murali): themes, named
colors, teaching views, and examples.

```bash
python3 -m pip install murali-kit==0.3.0
```

That pulls a compatible `murali-engine` wheel on macOS, Linux, and Windows. Those platforms do not
need a local Rust toolchain.

```python
from murali_engine import Scene, Label
from murali_kit.colors import WHITE
from murali_kit.composite import TitleCard
from murali_kit.themes import DarkTheme, apply_theme

scene = apply_theme(Scene(), DarkTheme())
TitleCard("Murali Kit", "Python add-ons for Murali Engine").add_to_scene(scene)
scene.add(Label("Hello", height=0.3, color=WHITE))
scene.preview()
```

The engine owns `Scene`, primitives, timelines, preview, and export. Kit owns style and lesson
diagrams. The engine does not depend on the kit.

## Local development

```bash
python3 -m venv .venv
.venv/bin/python -m pip install -r requirements-local.txt
source .venv/bin/activate
export PYTHONPATH=src
python examples/hello_shapes.py
python preview_all.py --auto
```

`requirements-local.txt` installs the adjacent `../murali` checkout. Use `requirements-git.txt` to
install the engine from GitHub instead.

How to run the catalog: [examples/README.md](examples/README.md).  
How to publish: [RELEASE.md](RELEASE.md).
