murali-kit 0.1.0__py3-none-any.whl

murali_kit/__init__.py

@@ -0,0 +1,13 @@
+"""Free Python authoring kit and add-ons for Murali Engine."""
+
+from ._compat import ENGINE_IMPORT_NAME, SUPPORTED_ENGINE, engine_available, require_engine
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "ENGINE_IMPORT_NAME",
+    "SUPPORTED_ENGINE",
+    "__version__",
+    "engine_available",
+    "require_engine",
+]

murali_kit/_compat.py

@@ -0,0 +1,30 @@
+"""Compatibility helpers for the Murali Engine Python package."""
+
+from __future__ import annotations
+
+import importlib
+import importlib.util
+from types import ModuleType
+
+ENGINE_IMPORT_NAME = "murali_engine"
+SUPPORTED_ENGINE = ">=0.2.5,<0.3.0"
+
+
+def engine_available() -> bool:
+    """Return whether the Murali Engine Python bindings are importable."""
+
+    return importlib.util.find_spec(ENGINE_IMPORT_NAME) is not None
+
+
+def require_engine() -> ModuleType:
+    """Import Murali Engine or raise a clear setup error."""
+
+    try:
+        return importlib.import_module(ENGINE_IMPORT_NAME)
+    except ImportError as exc:
+        msg = (
+            "murali-kit requires the murali-engine Python package for rendering. "
+            f"Expected engine compatibility: {SUPPORTED_ENGINE}. "
+            "For local development, run: python -m pip install -r requirements-local.txt"
+        )
+        raise RuntimeError(msg) from exc

murali_kit/ai/__init__.py

@@ -0,0 +1,3 @@
+"""AI visualization add-ons for Murali scenes."""
+
+__all__: list[str] = []

murali_kit/collection/__init__.py

@@ -0,0 +1,5 @@
+"""General-purpose authoring components for Murali scenes."""
+
+from .title_card import TitleCard, TitleCardHandles
+
+__all__ = ["TitleCard", "TitleCardHandles"]

murali_kit/collection/title_card.py

@@ -0,0 +1,72 @@
+"""Reusable title card composition for Murali scenes."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+from murali_kit._compat import require_engine
+
+Color = tuple[float, float, float, float]
+Vec3 = tuple[float, float, float]
+
+
+@dataclass(slots=True)
+class TitleCard:
+    """A small title/subtitle/card composition built from core engine primitives."""
+
+    title: str
+    subtitle: str | None = None
+    width: float = 5.8
+    height: float = 1.6
+    title_height: float = 0.34
+    subtitle_height: float = 0.2
+    fill: Color | None = None
+    stroke: Color | None = None
+    title_color: Color | None = None
+    subtitle_color: Color | None = None
+
+    def add_to_scene(self, scene: Any, at: Vec3 = (0.0, 0.0, 0.0)) -> "TitleCardHandles":
+        engine = require_engine()
+
+        fill = self.fill or (0.05, 0.10, 0.15, 0.96)
+        stroke = self.stroke or engine.WHITE
+        title_color = self.title_color or engine.WHITE
+        subtitle_color = self.subtitle_color or (0.75, 0.80, 0.86, 1.0)
+
+        card = engine.Rectangle(width=self.width, height=self.height, color=fill)
+        card.with_stroke(0.025, stroke)
+
+        x, y, z = at
+        card_handle = scene.add(card, at=at)
+        title_handle = scene.add(
+            engine.Label(self.title, height=self.title_height, color=title_color),
+            at=(x, y + 0.18, z + 0.01),
+        )
+
+        subtitle_handle = None
+        if self.subtitle:
+            subtitle_handle = scene.add(
+                engine.Label(self.subtitle, height=self.subtitle_height, color=subtitle_color),
+                at=(x, y - 0.28, z + 0.01),
+            )
+
+        return TitleCardHandles(
+            card=card_handle,
+            title=title_handle,
+            subtitle=subtitle_handle,
+        )
+
+
+@dataclass(frozen=True, slots=True)
+class TitleCardHandles:
+    card: Any
+    title: Any
+    subtitle: Any | None = None
+
+    @property
+    def all(self) -> tuple[Any, ...]:
+        handles = [self.card, self.title]
+        if self.subtitle is not None:
+            handles.append(self.subtitle)
+        return tuple(handles)

murali_kit/maths/__init__.py

@@ -0,0 +1,3 @@
+"""Math-focused add-ons for Murali scenes."""
+
+__all__: list[str] = []

murali_kit/maths/linear_algebra/__init__.py

@@ -0,0 +1,3 @@
+"""Linear algebra authoring components for Murali scenes."""
+
+__all__: list[str] = []

murali_kit-0.1.0.dist-info/METADATA

@@ -0,0 +1,116 @@
+Metadata-Version: 2.5
+Name: murali-kit
+Version: 0.1.0
+Summary: Free Python authoring kit and add-ons for Murali Engine.
+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
+Author: Murali Engine
+License: MIT OR Apache-2.0
+Keywords: ai,animation,education,math,visualization
+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
+Requires-Dist: murali-engine<0.3.0,>=0.2.5
+Description-Content-Type: text/markdown
+
+# Murali Kit
+
+Free Python authoring components and add-ons for Murali Engine.
+
+This repository is the free companion package for higher-level Murali visuals, examples, and
+education-focused helpers. The core runtime and PyO3 engine bindings live in the
+[`murali-engine/murali`](https://github.com/murali-engine/murali) repository.
+
+## Boundary
+
+- `murali-engine`: Rust engine, renderer, scene graph, timelines, preview/export, and Python
+  bindings for the core runtime.
+- `murali-kit`: Python add-ons built on top of `murali-engine`.
+
+The current split is non-destructive. Existing Rust collection code remains in the engine repo until
+each add-on surface has a Python equivalent and a stable engine contract.
+
+See [docs/SPLIT_PLAN.md](docs/SPLIT_PLAN.md) for the migration plan.
+
+## First Component
+
+`murali-kit` now includes a small `TitleCard` composition:
+
+```python
+from murali_engine import Scene
+from murali_kit.collection import TitleCard
+
+scene = Scene()
+handles = TitleCard("Murali Kit", "Python add-ons for Murali Engine").add_to_scene(scene)
+```
+
+`murali-kit` depends on the `murali-engine` Python package:
+
+```bash
+python3 -m pip install murali-kit==0.1.0
+```
+
+During local development, create a virtual environment inside this repo and install the adjacent
+engine checkout plus this kit package:
+
+```bash
+python3 -m venv .venv
+.venv/bin/python -m pip install -r requirements-local.txt
+```
+
+Activate the environment:
+
+```bash
+source .venv/bin/activate
+```
+
+Run the examples:
+
+```bash
+python examples/core_surfaces.py
+python examples/hello_shapes.py
+python examples/shapes_and_layout.py
+python examples/three_d_scene.py
+python examples/title_card.py
+```
+
+By default these open the preview window. To export a single PNG frame instead:
+
+```bash
+python examples/core_surfaces.py --png
+python examples/hello_shapes.py --png
+python examples/shapes_and_layout.py --png
+python examples/three_d_scene.py --png
+python examples/title_card.py --png
+```
+
+To try every Python example one by one:
+
+```bash
+python preview_all.py
+```
+
+For a non-window export pass:
+
+```bash
+python preview_all.py --png
+```
+
+You can also run them without activation:
+
+```bash
+.venv/bin/python examples/core_surfaces.py
+.venv/bin/python examples/hello_shapes.py
+.venv/bin/python examples/shapes_and_layout.py
+.venv/bin/python examples/three_d_scene.py
+.venv/bin/python examples/title_card.py
+```
+
+See [RUNNING_EXAMPLES.md](RUNNING_EXAMPLES.md) for the full local workflow.

murali_kit-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+murali_kit/__init__.py,sha256=RriIG21ur6smvPfhrHjMlS6ETFb1wQDCwa2iSPCKxIw,309
+murali_kit/_compat.py,sha256=_DOz2VoT-fFge4PSXulrLhD4UwBoJNGzQWANaQQAEGU,929
+murali_kit/ai/__init__.py,sha256=uw-MEIQmFr1h-nDmEsyTRtL6cJ0FC6ju-5JmgYVdgtw,75
+murali_kit/collection/__init__.py,sha256=o7rOPO_94TQRFV0K91PeFzuxFoUOc01NsPHO1FCHDYM,160
+murali_kit/collection/title_card.py,sha256=axSbdX-Wg3evzSfR5KrGrgJvhnqjuKZ7hWDybNImm7E,2133
+murali_kit/maths/__init__.py,sha256=kfzXRVEpqaJ3xop25ZJE2QrL2sSVGxEU7qIafvdwMn8,71
+murali_kit/maths/linear_algebra/__init__.py,sha256=BBxB5achnBAqeApsrwcX1QaPzYL-8MoGxdrH0RctXYE,86
+murali_kit-0.1.0.dist-info/METADATA,sha256=tGo4CdimBdxJgzlOZFZnSdvbZxomqFxfFZ395LhzAf8,3375
+murali_kit-0.1.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+murali_kit-0.1.0.dist-info/RECORD,,

murali_kit-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any