Skip to content

development.md

Latest commit

 

History

History
42 lines (28 loc) · 933 Bytes

development.md

File metadata and controls

42 lines (28 loc) · 933 Bytes
Raw

Development

Use the devcontainer or local Python 3.11+ install for development.

Devcontainer

Open the repository in VS Code and run Dev Containers: Reopen in Container. The devcontainer builds from the same root Dockerfile as the reusable runtime image and installs the project in editable mode.

Local Install

python -m pip install -e ".[dev]"

Tests

Run:

pytest tests -q

If the package is not installed in the current shell, use:

$env:PYTHONPATH='src'; pytest tests -q

The GitHub Actions test workflow runs:

  • catalog validation
  • Python tests in manimcommunity/manim:v0.20.1
  • runtime image smoke checks against the external project fixture

Development Principles

  • Keep Python scene files as the source of truth.
  • Build the Studio workflow before adding deeper automation.
  • Keep generated output out of Git.
  • Keep MCP operations structured and safe.