manim-simplex 0.2.0__tar.gz → 0.2.2__tar.gz

{manim_simplex-0.2.0 → manim_simplex-0.2.2}/CHANGELOG.md

@@ -6,6 +6,12 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [0.2.1] - 2026-05-24
+
+### Changed
+
+- Highlight Pygments word operators in the Darcula code style.
+
 ## [0.2.0] - 2026-05-24
 
 ### Added

manim_simplex-0.2.2/PKG-INFO

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: manim-simplex
+Version: 0.2.2
+Summary: Manim plugin: theme tokens, mobjects, slide hierarchy, deck manifest schema.
+Project-URL: Changelog, https://github.com/shlomi-perles/manim-simplex/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://github.com/shlomi-perles/manim-simplex
+Project-URL: Issues, https://github.com/shlomi-perles/manim-simplex/issues
+Project-URL: Repository, https://github.com/shlomi-perles/manim-simplex
+Author: Shlomi Perles
+License-Expression: MIT
+License-File: LICENSE
+Keywords: animation,computer-science,education,lecture,manim,manim-slides,math,presentation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Education
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: manim-slides>=5.1.7
+Requires-Dist: manim>=0.20.1
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pygments>=2.18
+Requires-Dist: pymupdf>=1.27.2.3
+Description-Content-Type: text/markdown
+
+# manim-simplex
+
+[![PyPI version](https://img.shields.io/pypi/v/manim-simplex.svg)](https://pypi.org/project/manim-simplex/)
+[![Python](https://img.shields.io/pypi/pyversions/manim-simplex.svg)](https://pypi.org/project/manim-simplex/)
+[![CI](https://github.com/shlomi-perles/manim-simplex/actions/workflows/ci.yml/badge.svg)](https://github.com/shlomi-perles/manim-simplex/actions/workflows/ci.yml)
+[![License](https://img.shields.io/pypi/l/manim-simplex.svg)](https://github.com/shlomi-perles/manim-simplex/blob/main/LICENSE)
+
+`manim-simplex` is the Manim plugin layer for Simplex: theme tokens,
+slide bases, reusable mobjects, animation helpers, and the shared deck
+manifest schema used by the Simplex web builder.
+
+It is published as `manim-simplex` and exposes modules under the
+implicit namespace package `simplex`.
+
+## Requirements
+
+- Python 3.13+
+- Manim Community 0.20.1+
+- manim-slides 5.1.7+
+- Manim's system dependencies, including FFmpeg, Cairo, Pango, and a TeX
+  distribution when rendering TeX. See the Manim installation guide:
+  https://docs.manim.community/en/stable/installation.html
+
+## Install
+
+```bash
+pip install manim-simplex
+```
+
+With uv:
+
+```bash
+uv add manim-simplex
+```
+
+Verify that Manim can discover the plugin:
+
+```bash
+python -m manim plugins -l
+```
+
+The output should include `simplex`.
+
+## Configure Manim
+
+Enable the plugin in the `manim.cfg` next to your scenes or deck:
+
+```ini
+[CLI]
+plugins = simplex
+save_sections = True
+```
+
+Manim imports `simplex.plugin` through the `manim.plugins` entry point.
+The plugin applies the active Simplex theme to Manim defaults, registers
+the Darcula Pygments style, sets the TeX template, sets the background
+color, and enables section JSON output.
+
+## Quick Start
+
+```python
+from manim import ORIGIN, MathTex, Write
+
+from simplex.slides import BaseSlide, make_chrome
+from simplex.theme import presets
+
+
+class HelloSlide(BaseSlide):
+    def setup(self) -> None:
+        super().setup()
+        chrome = make_chrome(
+            presets.DASTIMATOR_DARK,
+            self.region,
+            header="Hello, Simplex",
+        )
+        self.add_to_canvas(**chrome.mobjects)
+        self.region = chrome.body_region
+
+    def construct(self) -> None:
+        eq = MathTex(r"e^{i\pi} + 1 = 0")
+        self.region.place(eq, ORIGIN)
+        self.play(Write(eq))
+        self.next_slide()  # first call -> MAIN named "Hello Slide"
+
+        consequence = MathTex(r"\therefore\ \cos\pi + i\sin\pi = -1")
+        self.region.place(consequence, ORIGIN)
+        self.play(Write(consequence))
+        self.next_slide()  # later bare calls -> SUB stops
+```
+
+Render as a slide deck:
+
+```bash
+manim-slides render path/to/scene.py HelloSlide
+manim-slides present HelloSlide
+```
+
+Or, in a uv-managed project:
+
+```bash
+uv run manim-slides render path/to/scene.py HelloSlide
+uv run manim-slides present HelloSlide
+```
+
+## What Ships Here
+
+| Module | Public surface |
+| --- | --- |
+| `simplex.plugin` | `activate()` entry point used by Manim. |
+| `simplex.slides` | `BaseSlide`, `OutlineScene`, `OutlinePart`, `Chrome`, `make_chrome`. |
+| `simplex.engine` | `Region`, `Remove`, `clear_scene`, `exit_for`, `register_exit`, `set_exit_animation`, `HighlightResult`, `apply_theme_defaults`. |
+| `simplex.mobjects` | `Node`, `Edge`, `ArrayMob`, `ArrayEntry`, `ArrayPointer`, `OutlineProgressBar`. |
+| `simplex.theme` | `Theme`, `Palette`, `Typography`, `Spacing`, `Motion`, `LatexProfile`, `WebPalette`, `active_theme`, `get_active_theme`, `presets`, `render_web_css`. |
+| `simplex.section` | `SimplexSectionType`, the section strings written into Manim section JSON. |
+| `simplex.manifest` | `DeckManifest`, `MainSlide`, `Subsection`, the Pydantic schema shared with `simplex-py`. |
+
+Additional focused helpers live in submodules such as
+`simplex.engine.glyph_map`, `simplex.engine.code`,
+`simplex.engine.geometry`, `simplex.engine.text`, and
+`simplex.engine.debug`.
+
+## Slide Hierarchy
+
+`BaseSlide.next_slide` writes Simplex section types into Manim's native
+section JSON. The `simplex-py` web builder later reconciles those
+sections with manim-slides metadata.
+
+```python
+self.next_slide(name="Title")          # MAIN slide named "Title"
+self.next_slide()                      # first bare call: MAIN named after the class
+self.next_slide()                      # later bare calls: SUB slide
+self.next_slide(loop=True)             # loop variant
+self.next_slide(section_type="simplex.main.skip")  # explicit override
+```
+
+The first bare call is auto-named from the scene class, so
+`DFSLecture` becomes `DFS Lecture`.
+
+## Themes
+
+Themes are frozen Pydantic models. The same theme instance drives Manim
+defaults, TeX defaults, Pygments highlighting, and CSS variables for the
+web portal.
+
+```python
+from manim import Tex
+
+from simplex.theme import presets
+from simplex.theme.context import active_theme
+
+
+with active_theme(presets.ACADEMIC_LIGHT):
+    label = Tex("This Tex uses the academic light palette.")
+```
+
+Available presets include `DASTIMATOR_DARK` and `ACADEMIC_LIGHT`.
+
+## Outline Slides
+
+`OutlineScene` turns typed `OutlinePart` objects into an animated agenda
+slide with progress indicators.
+
+```python
+from manim import Circle, Square, Tex
+
+from simplex.engine.text import Caption
+from simplex.slides import OutlinePart, OutlineScene
+
+
+class Outline(OutlineScene):
+    def __init__(self, **kwargs):
+        super().__init__(
+            parts=[
+                OutlinePart(Tex("Research Question"), Caption("Question"), Circle()),
+                OutlinePart(Tex("Algorithms"), Caption("Algorithms"), Square()),
+            ],
+            section_name="Outline",
+            **kwargs,
+        )
+```
+
+## Examples
+
+This repository includes runnable examples:
+
+```bash
+uv run manim -pql examples/theme_demo.py ThemeDemo
+uv run manim -pql examples/glyph_map_demo.py GlyphMapDemo
+uv run manim-slides render examples/hello_slide.py HelloSlide
+uv run manim-slides render examples/outline_slide.py OutlineDemo
+```
+
+The examples directory has its own `manim.cfg`, so the Simplex plugin is
+enabled when commands are run from the repository root.
+
+## Relationship To `simplex-py`
+
+Simplex is split into two PyPI distributions:
+
+| Distribution | Import namespace | Purpose |
+| --- | --- | --- |
+| `manim-simplex` | `simplex.*` | Manim plugin, slide bases, theme, mobjects, manifest schema. |
+| `simplex-py` | `simplex.*` | CLI, deck discovery, render orchestration, and static web portal. |
+
+Both wheels intentionally contribute to the same PEP 420 namespace. This
+package does not ship `simplex/__init__.py`; neither should downstream
+extensions that want to share the namespace.
+
+Install only `manim-simplex` if you want to render scenes and slides.
+Install `simplex-py` later when you want the full lecture portal and CLI.
+
+## Development
+
+```bash
+git clone https://github.com/shlomi-perles/manim-simplex.git
+cd manim-simplex
+uv sync --all-extras
+uv run pre-commit install
+```
+
+Useful checks:
+
+```bash
+uv run ruff check .
+uv run ruff format --check .
+uv run basedpyright
+uv run pytest -q
+uv build
+uvx twine check dist/*
+```
+
+Run plugin smoke tests locally:
+
+```bash
+uv run python -c "import simplex.plugin; simplex.plugin.activate(); print('ok')"
+uv run manim plugins -l
+```
+
+## Release
+
+Releases are published to PyPI by GitHub Actions through PyPI Trusted
+Publishing. To release a new version:
+
+1. Update `version` in `pyproject.toml`.
+2. Move changelog entries under a dated release heading.
+3. Commit the release prep.
+4. Push an annotated tag such as `v0.2.1`.
+
+The `Publish to PyPI` workflow builds an sdist and wheel, checks both
+with Twine, uploads them as a GitHub artifact, and publishes to PyPI via
+OIDC.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

manim_simplex-0.2.2/README.md

@@ -0,0 +1,255 @@
+# manim-simplex
+
+[![PyPI version](https://img.shields.io/pypi/v/manim-simplex.svg)](https://pypi.org/project/manim-simplex/)
+[![Python](https://img.shields.io/pypi/pyversions/manim-simplex.svg)](https://pypi.org/project/manim-simplex/)
+[![CI](https://github.com/shlomi-perles/manim-simplex/actions/workflows/ci.yml/badge.svg)](https://github.com/shlomi-perles/manim-simplex/actions/workflows/ci.yml)
+[![License](https://img.shields.io/pypi/l/manim-simplex.svg)](https://github.com/shlomi-perles/manim-simplex/blob/main/LICENSE)
+
+`manim-simplex` is the Manim plugin layer for Simplex: theme tokens,
+slide bases, reusable mobjects, animation helpers, and the shared deck
+manifest schema used by the Simplex web builder.
+
+It is published as `manim-simplex` and exposes modules under the
+implicit namespace package `simplex`.
+
+## Requirements
+
+- Python 3.13+
+- Manim Community 0.20.1+
+- manim-slides 5.1.7+
+- Manim's system dependencies, including FFmpeg, Cairo, Pango, and a TeX
+  distribution when rendering TeX. See the Manim installation guide:
+  https://docs.manim.community/en/stable/installation.html
+
+## Install
+
+```bash
+pip install manim-simplex
+```
+
+With uv:
+
+```bash
+uv add manim-simplex
+```
+
+Verify that Manim can discover the plugin:
+
+```bash
+python -m manim plugins -l
+```
+
+The output should include `simplex`.
+
+## Configure Manim
+
+Enable the plugin in the `manim.cfg` next to your scenes or deck:
+
+```ini
+[CLI]
+plugins = simplex
+save_sections = True
+```
+
+Manim imports `simplex.plugin` through the `manim.plugins` entry point.
+The plugin applies the active Simplex theme to Manim defaults, registers
+the Darcula Pygments style, sets the TeX template, sets the background
+color, and enables section JSON output.
+
+## Quick Start
+
+```python
+from manim import ORIGIN, MathTex, Write
+
+from simplex.slides import BaseSlide, make_chrome
+from simplex.theme import presets
+
+
+class HelloSlide(BaseSlide):
+    def setup(self) -> None:
+        super().setup()
+        chrome = make_chrome(
+            presets.DASTIMATOR_DARK,
+            self.region,
+            header="Hello, Simplex",
+        )
+        self.add_to_canvas(**chrome.mobjects)
+        self.region = chrome.body_region
+
+    def construct(self) -> None:
+        eq = MathTex(r"e^{i\pi} + 1 = 0")
+        self.region.place(eq, ORIGIN)
+        self.play(Write(eq))
+        self.next_slide()  # first call -> MAIN named "Hello Slide"
+
+        consequence = MathTex(r"\therefore\ \cos\pi + i\sin\pi = -1")
+        self.region.place(consequence, ORIGIN)
+        self.play(Write(consequence))
+        self.next_slide()  # later bare calls -> SUB stops
+```
+
+Render as a slide deck:
+
+```bash
+manim-slides render path/to/scene.py HelloSlide
+manim-slides present HelloSlide
+```
+
+Or, in a uv-managed project:
+
+```bash
+uv run manim-slides render path/to/scene.py HelloSlide
+uv run manim-slides present HelloSlide
+```
+
+## What Ships Here
+
+| Module | Public surface |
+| --- | --- |
+| `simplex.plugin` | `activate()` entry point used by Manim. |
+| `simplex.slides` | `BaseSlide`, `OutlineScene`, `OutlinePart`, `Chrome`, `make_chrome`. |
+| `simplex.engine` | `Region`, `Remove`, `clear_scene`, `exit_for`, `register_exit`, `set_exit_animation`, `HighlightResult`, `apply_theme_defaults`. |
+| `simplex.mobjects` | `Node`, `Edge`, `ArrayMob`, `ArrayEntry`, `ArrayPointer`, `OutlineProgressBar`. |
+| `simplex.theme` | `Theme`, `Palette`, `Typography`, `Spacing`, `Motion`, `LatexProfile`, `WebPalette`, `active_theme`, `get_active_theme`, `presets`, `render_web_css`. |
+| `simplex.section` | `SimplexSectionType`, the section strings written into Manim section JSON. |
+| `simplex.manifest` | `DeckManifest`, `MainSlide`, `Subsection`, the Pydantic schema shared with `simplex-py`. |
+
+Additional focused helpers live in submodules such as
+`simplex.engine.glyph_map`, `simplex.engine.code`,
+`simplex.engine.geometry`, `simplex.engine.text`, and
+`simplex.engine.debug`.
+
+## Slide Hierarchy
+
+`BaseSlide.next_slide` writes Simplex section types into Manim's native
+section JSON. The `simplex-py` web builder later reconciles those
+sections with manim-slides metadata.
+
+```python
+self.next_slide(name="Title")          # MAIN slide named "Title"
+self.next_slide()                      # first bare call: MAIN named after the class
+self.next_slide()                      # later bare calls: SUB slide
+self.next_slide(loop=True)             # loop variant
+self.next_slide(section_type="simplex.main.skip")  # explicit override
+```
+
+The first bare call is auto-named from the scene class, so
+`DFSLecture` becomes `DFS Lecture`.
+
+## Themes
+
+Themes are frozen Pydantic models. The same theme instance drives Manim
+defaults, TeX defaults, Pygments highlighting, and CSS variables for the
+web portal.
+
+```python
+from manim import Tex
+
+from simplex.theme import presets
+from simplex.theme.context import active_theme
+
+
+with active_theme(presets.ACADEMIC_LIGHT):
+    label = Tex("This Tex uses the academic light palette.")
+```
+
+Available presets include `DASTIMATOR_DARK` and `ACADEMIC_LIGHT`.
+
+## Outline Slides
+
+`OutlineScene` turns typed `OutlinePart` objects into an animated agenda
+slide with progress indicators.
+
+```python
+from manim import Circle, Square, Tex
+
+from simplex.engine.text import Caption
+from simplex.slides import OutlinePart, OutlineScene
+
+
+class Outline(OutlineScene):
+    def __init__(self, **kwargs):
+        super().__init__(
+            parts=[
+                OutlinePart(Tex("Research Question"), Caption("Question"), Circle()),
+                OutlinePart(Tex("Algorithms"), Caption("Algorithms"), Square()),
+            ],
+            section_name="Outline",
+            **kwargs,
+        )
+```
+
+## Examples
+
+This repository includes runnable examples:
+
+```bash
+uv run manim -pql examples/theme_demo.py ThemeDemo
+uv run manim -pql examples/glyph_map_demo.py GlyphMapDemo
+uv run manim-slides render examples/hello_slide.py HelloSlide
+uv run manim-slides render examples/outline_slide.py OutlineDemo
+```
+
+The examples directory has its own `manim.cfg`, so the Simplex plugin is
+enabled when commands are run from the repository root.
+
+## Relationship To `simplex-py`
+
+Simplex is split into two PyPI distributions:
+
+| Distribution | Import namespace | Purpose |
+| --- | --- | --- |
+| `manim-simplex` | `simplex.*` | Manim plugin, slide bases, theme, mobjects, manifest schema. |
+| `simplex-py` | `simplex.*` | CLI, deck discovery, render orchestration, and static web portal. |
+
+Both wheels intentionally contribute to the same PEP 420 namespace. This
+package does not ship `simplex/__init__.py`; neither should downstream
+extensions that want to share the namespace.
+
+Install only `manim-simplex` if you want to render scenes and slides.
+Install `simplex-py` later when you want the full lecture portal and CLI.
+
+## Development
+
+```bash
+git clone https://github.com/shlomi-perles/manim-simplex.git
+cd manim-simplex
+uv sync --all-extras
+uv run pre-commit install
+```
+
+Useful checks:
+
+```bash
+uv run ruff check .
+uv run ruff format --check .
+uv run basedpyright
+uv run pytest -q
+uv build
+uvx twine check dist/*
+```
+
+Run plugin smoke tests locally:
+
+```bash
+uv run python -c "import simplex.plugin; simplex.plugin.activate(); print('ok')"
+uv run manim plugins -l
+```
+
+## Release
+
+Releases are published to PyPI by GitHub Actions through PyPI Trusted
+Publishing. To release a new version:
+
+1. Update `version` in `pyproject.toml`.
+2. Move changelog entries under a dated release heading.
+3. Commit the release prep.
+4. Push an annotated tag such as `v0.2.1`.
+
+The `Publish to PyPI` workflow builds an sdist and wheel, checks both
+with Twine, uploads them as a GitHub artifact, and publishes to PyPI via
+OIDC.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

{manim_simplex-0.2.0 → manim_simplex-0.2.2}/pyproject.toml

@@ -33,6 +33,7 @@ dependencies = [
   "manim-slides>=5.1.7",
   "pydantic>=2.7",
   "pygments>=2.18",
+  "pymupdf>=1.27.2.3",
 ]
 description = "Manim plugin: theme tokens, mobjects, slide hierarchy, deck manifest schema."
 keywords = [
@@ -50,7 +51,7 @@ license-files = ["LICENSE"]
 name = "manim-simplex"
 readme = "README.md"
 requires-python = ">=3.13"
-version = "0.2.0"
+version = "0.2.2"
 
 [project.entry-points."manim.plugins"]
 simplex = "simplex.plugin:activate"

{manim_simplex-0.2.0 → manim_simplex-0.2.2}/src/simplex/engine/animations.py

@@ -66,10 +66,16 @@ class _DefaultRegistry:
             VMobject,
         )
 
+        from simplex.mobjects.paper import DismissPaper, Paper
+
         def fade_with_drift(m: Any, **kw: Any) -> Any:
             return FadeOut(m, shift=0.1 * DOWN, **kw)
 
+        def paper_exit(m: Any, **kw: Any) -> Any:
+            return DismissPaper(m, **kw)
+
         return {
+            Paper: paper_exit,
             Tex: Unwrite,
             MathTex: Unwrite,
             Text: Unwrite,

{manim_simplex-0.2.0 → manim_simplex-0.2.2}/src/simplex/mobjects/__init__.py

@@ -9,5 +9,17 @@ slide system.
 from simplex.mobjects.array import ArrayEntry, ArrayMob, ArrayPointer
 from simplex.mobjects.graph import Edge, Node
 from simplex.mobjects.outline import OutlineProgressBar
+from simplex.mobjects.paper import DismissPaper, Paper, PickPage, ShowPaper
 
-__all__ = ["ArrayEntry", "ArrayMob", "ArrayPointer", "Edge", "Node", "OutlineProgressBar"]
+__all__ = [
+    "ArrayEntry",
+    "ArrayMob",
+    "ArrayPointer",
+    "DismissPaper",
+    "Edge",
+    "Node",
+    "OutlineProgressBar",
+    "Paper",
+    "PickPage",
+    "ShowPaper",
+]