simplex-web 0.2.0__tar.gz

simplex_web-0.2.0/.gitignore

@@ -0,0 +1,41 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# uv
+.venv/
+
+# Tool caches
+.ruff_cache/
+.pytest_cache/
+.basedpyright/
+.simplex_cache/
+.mypy_cache/
+
+# Manim output
+media/
+decks/**/slides/*.json
+decks/**/slides/files/
+
+# Generated site
+site/
+
+# Vendored web runtime assets (fetched on demand by simplex.web.vendor)
+src/simplex/web/static/tailwind.js
+src/simplex/web/static/htmx.min.js
+src/simplex/web/static/katex/
+src/simplex/web/static/reveal.js/
+src/simplex/web/static/fonts/
+
+# Editors
+.idea/
+.vscode/
+*.swp
+.DS_Store

simplex_web-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shlomi Perles
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

simplex_web-0.2.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: simplex-web
+Version: 0.2.0
+Summary: Manim-slides presentation framework with a generated web portal.
+Project-URL: Homepage, https://github.com/shlomi-perles/simplex
+Project-URL: Issues, https://github.com/shlomi-perles/simplex/issues
+Project-URL: Repository, https://github.com/shlomi-perles/simplex
+Author: Shlomi Perles
+License-Expression: MIT
+License-File: LICENSE
+Keywords: animation,computer-science,education,lecture,manim,manim-slides,math,presentation,static-site
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+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 :: Internet :: WWW/HTTP :: Site Management
+Classifier: Topic :: Multimedia :: Graphics
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: av>=15.0
+Requires-Dist: jinja2>=3.1
+Requires-Dist: manim-simplex>=0.2.0
+Requires-Dist: manim-slides>=5.1.7
+Requires-Dist: markdown-it-py>=3.0
+Requires-Dist: mdit-py-plugins>=0.4
+Requires-Dist: pillow>=11.0
+Requires-Dist: platformdirs>=4.2
+Requires-Dist: pydantic-settings>=2.3
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pygments>=2.18
+Requires-Dist: rich>=13.7
+Requires-Dist: structlog>=24.1
+Requires-Dist: tomli-w>=1.0
+Requires-Dist: typer>=0.12
+Requires-Dist: watchfiles>=0.24
+Description-Content-Type: text/markdown
+
+# Simplex
+
+A Manim-slides presentation framework with a generated web portal.
+
+Authors write **vanilla Manim** (`MathTex(...)`, `VGroup(...).arrange(RIGHT)`); Simplex configures defaults underneath via frozen theme tokens. A `simplex new` command scaffolds a new deck; `simplex build` renders every deck and produces a static portal for GitHub Pages.
+
+## The three repos
+
+`simplex` is one of three packages that together make up the v0.2.0 toolkit:
+
+| Repo | PyPI | Role |
+|---|---|---|
+| [`manim-simplex`](https://github.com/shlomi-perles/manim-simplex) | `manim-simplex` | The manim plugin: mobjects, theme, `BaseSlide`, the `manim.plugins` entry-point. |
+| [`simplex`](https://github.com/shlomi-perles/simplex) | `simplex-web` | The platform: CLI, deck discovery, render orchestration, web builder. Depends on `manim-simplex`. |
+| [`simplex-lectures-template`](https://github.com/shlomi-perles/simplex-lectures-template) | -- | GitHub Template. Pre-wired user lectures repo. |
+
+The PyPI slot `simplex` was already taken by an unrelated project, and PyPI's
+name-similarity guard rejects short variants, so this distribution publishes
+as `simplex-web`. The *import* name is still
+`simplex` -- both wheels ship `src/simplex/` **without** `__init__.py` and
+Python's PEP 420 implicit namespace packages merge them at import time, so
+`from simplex.engine import Remove` and `from simplex.cli.commands import app`
+resolve regardless of which wheel ships the module.
+
+## Quick start
+
+```bash
+# Install from PyPI:
+pip install simplex-web
+
+# Bootstrap a fresh checkout (Linux / macOS):
+./scripts/bootstrap.sh
+
+# Or on Windows:
+.\\scripts\\bootstrap.ps1
+
+# Scaffold a new deck and render it:
+uv run simplex new my-first-deck
+uv run simplex render my-first-deck
+
+# Generate the portal and preview it locally:
+uv run simplex build
+uv run simplex serve
+```
+
+## Repository layout
+
+```
+simplex/
+|-- src/simplex/          (no __init__.py -- PEP 420 namespace)
+|   |-- deck/             DeckConfig, discovery, scaffolder
+|   |-- render/           runner, reconcile, html/pdf/pptx, thumbnail
+|   |-- web/              markdown notes + Jinja portal + SSE reload
+|   `-- cli/              Typer entry point
+|-- decks/                author content (one directory per deck)
+`-- tests/
+
+# Plugin half (mobjects, theme, slide bases) lives in manim-simplex.
+```
+
+Every directory ships a short `README.md` (<=50 lines) covering *scope*, *public surface*, and *don'ts*. Only this root README is long-form.
+
+## Authoring a deck
+
+A deck is three files plus optional assets:
+
+```
+decks/my-deck/
+|-- deck.toml      slug, title, summary, tags, theme, scenes, quality
+|-- slides.py      vanilla Manim, subclassing simplex.slides.*
+|-- notes.md       English notes rendered into the portal
+`-- assets/
+```
+
+Inside `slides.py` you write plain Manim -- the framework's only contribution is the base class plus a pure `make_chrome` factory:
+
+```python
+from manim import MathTex, ORIGIN, Write
+from simplex.slides import BaseSlide, make_chrome
+from simplex.theme.context import get_active_theme
+
+
+class FermatLittleTheorem(BaseSlide):
+    def setup(self) -> None:
+        super().setup()
+        chrome = make_chrome(get_active_theme(), self.region, header="Fermat's little theorem")
+        self.add_to_canvas(**chrome.mobjects)
+        self.region = chrome.body_region
+
+    def construct(self) -> None:
+        eq = MathTex(r"a^{p-1} \equiv 1 \pmod p")
+        self.region.place(eq, ORIGIN)
+        self.play(Write(eq))
+        self.next_slide()  # bare first call -> MAIN named "Fermat Little Theorem"
+```
+
+No factories, no wrappers, no anti-corruption wall. The theme provides defaults, `self.region` provides bounded layout, and `clear_scene(exclude=...)` provides bulk fade-outs. Slide numbering / wall clock live in the RevealJS host (toggle via `[web]` in `deck.toml`), not the rendered frames.
+
+## Theme tokens
+
+Presets are frozen `Theme` instances, not subclasses, so swapping the visual identity at runtime is one assignment:
+
+```python
+from simplex.theme import active_theme, presets
+
+with active_theme(presets.ACADEMIC_LIGHT):
+    # all slides constructed here pick up the light palette
+    ...
+```
+
+LaTeX preamble lives on `theme.latex.preamble`. Fixed-width prose blocks use the `TexPage` mobject (default 20 cm, override via `width_cm=…` kwarg or a class attribute on a subclass).
+
+## Style + tooling
+
+- Python **3.13+**, env + lockfile via **uv**, lint + format via **ruff**, types via **basedpyright --strict**.
+- Configuration through frozen **Pydantic v2** models. No bare `dict[str, Any]`.
+- See `STYLE.md` for the full rule set.
+
+## License
+
+MIT.

simplex_web-0.2.0/README.md

@@ -0,0 +1,121 @@
+# Simplex
+
+A Manim-slides presentation framework with a generated web portal.
+
+Authors write **vanilla Manim** (`MathTex(...)`, `VGroup(...).arrange(RIGHT)`); Simplex configures defaults underneath via frozen theme tokens. A `simplex new` command scaffolds a new deck; `simplex build` renders every deck and produces a static portal for GitHub Pages.
+
+## The three repos
+
+`simplex` is one of three packages that together make up the v0.2.0 toolkit:
+
+| Repo | PyPI | Role |
+|---|---|---|
+| [`manim-simplex`](https://github.com/shlomi-perles/manim-simplex) | `manim-simplex` | The manim plugin: mobjects, theme, `BaseSlide`, the `manim.plugins` entry-point. |
+| [`simplex`](https://github.com/shlomi-perles/simplex) | `simplex-web` | The platform: CLI, deck discovery, render orchestration, web builder. Depends on `manim-simplex`. |
+| [`simplex-lectures-template`](https://github.com/shlomi-perles/simplex-lectures-template) | -- | GitHub Template. Pre-wired user lectures repo. |
+
+The PyPI slot `simplex` was already taken by an unrelated project, and PyPI's
+name-similarity guard rejects short variants, so this distribution publishes
+as `simplex-web`. The *import* name is still
+`simplex` -- both wheels ship `src/simplex/` **without** `__init__.py` and
+Python's PEP 420 implicit namespace packages merge them at import time, so
+`from simplex.engine import Remove` and `from simplex.cli.commands import app`
+resolve regardless of which wheel ships the module.
+
+## Quick start
+
+```bash
+# Install from PyPI:
+pip install simplex-web
+
+# Bootstrap a fresh checkout (Linux / macOS):
+./scripts/bootstrap.sh
+
+# Or on Windows:
+.\\scripts\\bootstrap.ps1
+
+# Scaffold a new deck and render it:
+uv run simplex new my-first-deck
+uv run simplex render my-first-deck
+
+# Generate the portal and preview it locally:
+uv run simplex build
+uv run simplex serve
+```
+
+## Repository layout
+
+```
+simplex/
+|-- src/simplex/          (no __init__.py -- PEP 420 namespace)
+|   |-- deck/             DeckConfig, discovery, scaffolder
+|   |-- render/           runner, reconcile, html/pdf/pptx, thumbnail
+|   |-- web/              markdown notes + Jinja portal + SSE reload
+|   `-- cli/              Typer entry point
+|-- decks/                author content (one directory per deck)
+`-- tests/
+
+# Plugin half (mobjects, theme, slide bases) lives in manim-simplex.
+```
+
+Every directory ships a short `README.md` (<=50 lines) covering *scope*, *public surface*, and *don'ts*. Only this root README is long-form.
+
+## Authoring a deck
+
+A deck is three files plus optional assets:
+
+```
+decks/my-deck/
+|-- deck.toml      slug, title, summary, tags, theme, scenes, quality
+|-- slides.py      vanilla Manim, subclassing simplex.slides.*
+|-- notes.md       English notes rendered into the portal
+`-- assets/
+```
+
+Inside `slides.py` you write plain Manim -- the framework's only contribution is the base class plus a pure `make_chrome` factory:
+
+```python
+from manim import MathTex, ORIGIN, Write
+from simplex.slides import BaseSlide, make_chrome
+from simplex.theme.context import get_active_theme
+
+
+class FermatLittleTheorem(BaseSlide):
+    def setup(self) -> None:
+        super().setup()
+        chrome = make_chrome(get_active_theme(), self.region, header="Fermat's little theorem")
+        self.add_to_canvas(**chrome.mobjects)
+        self.region = chrome.body_region
+
+    def construct(self) -> None:
+        eq = MathTex(r"a^{p-1} \equiv 1 \pmod p")
+        self.region.place(eq, ORIGIN)
+        self.play(Write(eq))
+        self.next_slide()  # bare first call -> MAIN named "Fermat Little Theorem"
+```
+
+No factories, no wrappers, no anti-corruption wall. The theme provides defaults, `self.region` provides bounded layout, and `clear_scene(exclude=...)` provides bulk fade-outs. Slide numbering / wall clock live in the RevealJS host (toggle via `[web]` in `deck.toml`), not the rendered frames.
+
+## Theme tokens
+
+Presets are frozen `Theme` instances, not subclasses, so swapping the visual identity at runtime is one assignment:
+
+```python
+from simplex.theme import active_theme, presets
+
+with active_theme(presets.ACADEMIC_LIGHT):
+    # all slides constructed here pick up the light palette
+    ...
+```
+
+LaTeX preamble lives on `theme.latex.preamble`. Fixed-width prose blocks use the `TexPage` mobject (default 20 cm, override via `width_cm=…` kwarg or a class attribute on a subclass).
+
+## Style + tooling
+
+- Python **3.13+**, env + lockfile via **uv**, lint + format via **ruff**, types via **basedpyright --strict**.
+- Configuration through frozen **Pydantic v2** models. No bare `dict[str, Any]`.
+- See `STYLE.md` for the full rule set.
+
+## License
+
+MIT.

simplex_web-0.2.0/pyproject.toml

@@ -0,0 +1,139 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+[dependency-groups]
+dev = [
+  "pytest>=8",
+  "pytest-xdist>=3.5",
+  "syrupy>=4.6",
+  "ruff>=0.6",
+  "basedpyright>=1.13",
+  "pre-commit>=3.7",
+]
+
+[project]
+authors = [{name = "Shlomi Perles"}]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Environment :: Console",
+  "Intended Audience :: Education",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3 :: Only",
+  "Topic :: Education",
+  "Topic :: Internet :: WWW/HTTP :: Site Management",
+  "Topic :: Multimedia :: Graphics",
+  "Topic :: Multimedia :: Video",
+  "Topic :: Scientific/Engineering :: Visualization",
+  "Typing :: Typed",
+]
+dependencies = [
+  "manim-simplex>=0.2.0",
+  "manim-slides>=5.1.7",
+  "pydantic>=2.7",
+  "pydantic-settings>=2.3",
+  "typer>=0.12",
+  "rich>=13.7",
+  "structlog>=24.1",
+  "jinja2>=3.1",
+  "markdown-it-py>=3.0",
+  "mdit-py-plugins>=0.4",
+  "pygments>=2.18",
+  "platformdirs>=4.2",
+  "tomli-w>=1.0",
+  "watchfiles>=0.24",
+  # Already transitive via manim, but the thumbnail extractor imports them
+  # directly so we pin them here too.
+  "av>=15.0",
+  "pillow>=11.0",
+]
+description = "Manim-slides presentation framework with a generated web portal."
+keywords = [
+  "manim",
+  "manim-slides",
+  "animation",
+  "presentation",
+  "lecture",
+  "education",
+  "math",
+  "computer-science",
+  "static-site",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+# PyPI distribution name. The import name stays ``simplex`` (a PEP 420
+# namespace shared with ``manim-simplex``); the wheel/sdist uses a longer
+# brand name because the bare ``simplex`` slot is taken and short variants
+# are rejected by PyPI's name-similarity guard.
+name = "simplex-web"
+readme = "README.md"
+requires-python = ">=3.13"
+version = "0.2.0"
+
+[project.scripts]
+simplex = "simplex.cli.commands:app"
+
+[project.urls]
+Homepage = "https://github.com/shlomi-perles/simplex"
+Issues = "https://github.com/shlomi-perles/simplex/issues"
+Repository = "https://github.com/shlomi-perles/simplex"
+
+[tool.basedpyright]
+include = ["src", "tests"]
+pythonVersion = "3.13"
+# Manim's 0.20.x type stubs are incomplete; mirror the same softening as
+# manim-simplex so this repo's CI passes for the same upstream reasons.
+reportArgumentType = "warning"
+reportAssignmentType = "warning"
+# manim-slides converters (PDF, PowerPoint, RevealJS) are Pydantic models
+# with sensible defaults the stubs don't expose; reportCallIssue fires on
+# every conversion call. Demote.
+reportCallIssue = "warning"
+reportInconsistentConstructor = "warning"
+reportMissingTypeStubs = false
+reportPrivateUsage = false
+reportReturnType = "warning"
+reportUnknownArgumentType = false
+reportUnknownLambdaType = "warning"
+reportUnknownMemberType = false
+reportUnknownVariableType = false
+typeCheckingMode = "strict"
+
+[tool.hatch.build.targets.sdist]
+artifacts = [
+  "src/simplex/web/static/fonts/**/*",
+  "src/simplex/web/static/htmx.min.js",
+  "src/simplex/web/static/katex/**/*",
+  "src/simplex/web/static/reveal.js/**/*",
+  "src/simplex/web/static/tailwind.js",
+]
+only-include = [
+  "LICENSE",
+  "README.md",
+  "pyproject.toml",
+  "src",
+  "tests",
+]
+
+[tool.hatch.build.targets.wheel]
+# Ship the deck template and vendored runtime assets inside the wheel so
+# ``simplex new`` and ``simplex build`` work from installed environments.
+# Hatchling otherwise drops ignored files and dotfile placeholders by default.
+artifacts = [
+  "src/simplex/deck/_template/**/*",
+  "src/simplex/deck/_template/**/.gitkeep",
+  "src/simplex/web/static/fonts/**/*",
+  "src/simplex/web/static/htmx.min.js",
+  "src/simplex/web/static/katex/**/*",
+  "src/simplex/web/static/reveal.js/**/*",
+  "src/simplex/web/static/tailwind.js",
+]
+packages = ["src/simplex"]
+
+[tool.pytest.ini_options]
+addopts = "-q"
+testpaths = ["tests"]

simplex_web-0.2.0/src/simplex/README.md

@@ -0,0 +1,32 @@
+# src/simplex
+
+The `simplex` distribution's half of the namespace: deck discovery,
+render pipeline, web portal, and CLI. The plugin half (`simplex.plugin`,
+`simplex.engine`, `simplex.theme`, `simplex.slides`) is shipped by the
+`manim-simplex` distribution and merged into this same namespace at
+import time via PEP 420.
+
+This directory ships **no** `__init__.py`. Don't add one -- it would
+shadow the implicit namespace and break the `manim-simplex` half.
+
+## Public surface (this distribution)
+
+- `simplex.deck` -- `DeckConfig`, `discover`, `scaffold`
+- `simplex.render` -- `runner`, `reconcile`, `html`, `pdf`, `pptx`, `thumbnail`
+- `simplex.web` -- `builder`, `notes`, bibliography stack, templates, static, SSE reload
+- `simplex.cli.commands:app` -- the Typer app behind `uv run simplex`
+
+## Public surface (re-exported from `manim-simplex`)
+
+- `simplex.plugin:activate` -- the `manim.plugins` entry-point (set `plugins = simplex` in your `manim.cfg`)
+- `simplex.slides` -- `BaseSlide`, `make_chrome`
+- `simplex.theme` -- `Theme`, `WebPalette`, `active_theme`, `get_active_theme`, `presets`, `render_web_css`
+- `simplex.engine` -- `apply_theme_defaults`, `Region`, `Remove`, `register_exit`, `set_exit_animation`, `clear_scene`, `SimplexSectionType`
+
+## Don't
+
+- Don't add `src/simplex/__init__.py`. The namespace must stay implicit.
+- Don't import `manim_editor`. The legacy package is deprecated and not a dependency.
+- Don't wrap Manim constructors. Authors write vanilla Manim; the framework configures defaults underneath via `Mobject.set_default(...)`.
+- Don't add a custom quality enum. Use `manim.constants.QUALITIES` keys directly.
+- Don't bypass the plugin entry-point by setting `manim.config` from your scene. The plugin runs once at import time; that's the correct seam.

simplex_web-0.2.0/src/simplex/cli/README.md

@@ -0,0 +1,13 @@
+# cli/
+
+Typer-based command surface exposed as `simplex` via `[project.scripts]`.
+
+## Public surface
+
+- `app` -- Typer application (entry point: `simplex.cli.commands:app`)
+- Commands: `new`, `render`, `build`, `serve`, `clean`, `doctor`
+
+## Don't
+
+- Don't add business logic here. Commands are thin shells over `deck`, `render`, and `web`.
+- Don't `os.chdir` outside of `serve`; that command intentionally enters `site/` to use `http.server`.

simplex_web-0.2.0/src/simplex/cli/__init__.py

@@ -0,0 +1,5 @@
+"""CLI entry point."""
+
+from simplex.cli.commands import app
+
+__all__ = ["app"]