robo-manim-add-ons 0.1.0

A collection of add-ons and utilities for Manim Community Edition

Robo Manim Add-ons

A collection of add-ons and utilities for Manim Community Edition.

Installation

For Users

Install from PyPI (once published):

pip install robo-manim-add-ons

For Development

1. Clone the repository:

git clone https://github.com/yourusername/robo-manim-add-ons.git
cd robo-manim-add-ons

2. Create and activate a virtual environment:

# Create venv
python -m venv venv

# Activate on macOS/Linux
source venv/bin/activate

# Activate on Windows
# venv\Scripts\activate

3. Install manim and development dependencies:

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

Or install from requirements files:

pip install -r requirements.txt
pip install -r requirements-dev.txt

Quick Start

from manim import *
from robo_manim_add_ons import CustomMobject

class MyScene(Scene):
    def construct(self):
        # Use your custom add-ons here
        obj = CustomMobject()
        self.play(Create(obj))
        self.wait()

Running Examples

# Make sure your venv is activated
source venv/bin/activate

# Run the demo
python examples/demo.py

Running Tests

# Make sure your venv is activated
source venv/bin/activate

# Run all tests
pytest

# Run with coverage
pytest --cov=robo_manim_add_ons

Project Structure

robo-manim-add-ons/
├── pyproject.toml              # Package configuration
├── setup.py                    # Setup file
├── README.md                   # This file
├── LICENSE                     # MIT License
├── requirements.txt            # Production dependencies
├── requirements-dev.txt        # Development dependencies
├── robo_manim_add_ons/        # Main package
│   ├── __init__.py
│   └── ...
├── tests/                      # Test suite
│   └── test_*.py
└── examples/                   # Usage examples
    └── demo.py

Development Workflow

1. Create and activate venv (see above)
2. Install in editable mode: pip install -e ".[dev]"
3. Make your changes
4. Run tests: pytest
5. Run examples to verify: python examples/demo.py

Building and Publishing

Build the package:

pip install build twine
python -m build

Publish to PyPI:

twine upload dist/*

Publish to TestPyPI (for testing):

twine upload --repository testpypi dist/*

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.