pyPlay

A flexible and performant video player for theatre.

Installation

Clone the repo:

git clone https://github.com/dmathies/pyPlay.git
cd pyPlay

Create a new virtual environment (optional):
(Unix):

python3 -m venv pyPlay_venv
source pyPlay_venv/bin/activate

(Windows):

python -m venv pyPlay_venv
pyPlay_venv\Scripts\activate

Install the required packages:

pip install requirements.txt
# If you intend on contributing to the project, get the dev-dependencies instead
# pip install requirements-dev.txt

Run pyPlay:

python main.py

Building for Rasperry Pi

When building for Rasperry Pis, it's recommended to build pyAv yourself to take full advantage of the hardware acceleration available on the pi.

Code format

Before committing any code to the repo, it's recommend to run it through the black formatter.

# cd pyPlay
python -m black .

Static typing is also highly recommended, this can be checked using mypy:

# cd pyPlay
# Explicit package bases is required for, this option should be removed once the ArtNet library stuff is cleaned up
mypy . --explicit-package-bases --follow-untyped-imports