otto

an ottomatic video creator

Install from pip

pip install al-otto

Optional packages

Otto ships with several optional packages, which can be installed with pip or pdm

pip install

pip install al-otto[test]

local pip install

pip install .[test]

pdm

pdm install -G test

Development

0. Install pdm

pip install pdm

1. Clone the repository

git clone https://github.com/quaternionmedia/otto.git

2. cd into the repo

cd otto

3. Install the development dependencies

pdm install

4. Create a local virtual environment

pdm venv create

5. Activate your local virtual environment

eval $(pdm venv activate)

Or...

source .venv/bin/activate

Deactivate your virtual environment by running deactivate

test

Inlcudes pytest and other testing dependencies. Run with:

pytest

Can also be run with VSCode Python test extension, or VSCode debugger.

render

Includes the python dependencies needed for rendering and effects.

NOTE Requires a working installation of imagemagick

docs

Includes documentation building tool. Run with:

mkdocs serve -a 0.0.0.0:9000

Then visit localhost:9000

nox

Running all tests and formatters can be done as a one-liner using nox

pip install nox

Then run:

nox

Sessions

To run a single session, i.e. just the test suite, run:

nox -s coverage

See noxfile.py for other commands.

Credits

Created by Quaternion Media, LLC