Setup

For new contributors: please first fork the repository to your own account

pip install pipenv
pipenv install --dev
pipenv shell
export PYTHONPATH=$(pwd)

Run via python ./opta/cli.py

Run Tests

make test

make build-binary

The module documentation can be generated by running:

./scripts/docs.py $TARGET_DIR

Create a new release on Github with a new tag (0..)
This will trigger the package github action, which creates the binary and uploads it to S3
Validate the binary by running some manual tests
Update the latest file in S3 to point to the new release in the S3 bucket
Update the docs website to point to this latest release