Skip to content

Adopt uv for installation, development, and CI - #2550

Open
shanezchang wants to merge 2 commits into
3b1b:masterfrom
shanezchang:codex/uv-environment
Open

shanezchang wants to merge 2 commits into
3b1b:masterfrom
shanezchang:codex/uv-environment

Conversation

@shanezchang

@shanezchang shanezchang commented Oct 29, 2026 •

Copy link
Copy Markdown

Motivation

Installation and contributor setup currently use several pip/conda paths, duplicate runtime requirements, and separate CI toolchains. This change makes uv the recommended workflow for a source checkout, with a committed lockfile shared by development and CI.

Proposed changes

  • Move package metadata and runtime dependencies to pyproject.toml, retaining setuptools and both CLI entry points. Include av, which VideoMobject imports but the previous package metadata omitted.
  • Add uv.lock, a Python 3.12 development interpreter, and separate test/documentation dependency groups. The package's supported Python range remains >=3.10.
  • Update the README, installation guide, quick start, configuration examples, and contributor guide to use uv sync --locked and uv run --locked.
  • Use uv for unit tests, isolated documentation builds, and release builds/uploads. Reuse the existing PyPI secrets and restrict Pages deployment to pushes to the default branch.
  • Retain standard Python build/install compatibility through setuptools, setup.py, and the small requirements.txt compatibility entry point.

Test

Validated on Apple Silicon / macOS 27.2 with Python 3.12.12 and uv 0.13.0:

uv sync --locked
uv pip check
uv run --locked pytest -q
uv build
uv run --locked --only-group docs sphinx-build -M html docs/source docs/build
uv run --locked manimgl example_scenes.py OpeningManimExample -w -l --fps 15
  • All six existing unit tests pass.
  • Source distribution and wheel build successfully; the wheel contains configuration, WGSL shaders, and the video module.
  • Documentation builds using only the docs dependency group. A clean build of the upstream docs with the same toolchain produces the same nine warnings; this change adds none.
  • The official example renders a 22-second, 330-frame H.264 video at 854×480. A separate short scene also exercises native text, LaTeX, animation, and encoding.

Fork CI for d34a44a6: Tests and documentation, both passed.

Related: #2458. This PR keeps the proposal focused on the environment, packaging, documentation, and CI.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant