Python 3.10 or higher is required.
This is not a tutorial for python, but if you don't have it installed, you can get it from python.org.
-
Clone the repository
-
Create a virtual environment with
python -m venv venv
|
-
Activate the virtual environment with
. ./venv/bin/activate
for linux or./venv/Scripts/activate
on Windows -
Install the requirements with
pip install -r requirements.txt
-
You're done! (the test files should not be run with python, instead they should be run with
pytest
)
-
Run
black .
to format the code -
Run
pytest
to make sure the tests pass -
Add the required dependencies with
pip freeze > requirements.txt
-
Add the required dependencies for GHA with
pip freeze > actionsReq.txt
and take out the pyaudio dependency and any failing dependencies -
Commit and push