Contribution

Create a venv in the root of the repo. Here the assumption is that the python is symlink to python3.

python -m venv .venv

Activate the environment.

source .venv/bin/activate

Confirm that the Python path is updated.

which python

The STDOUT should point to the .venv directory. Now, upgrade the pip.

python -m pip install --upgrade pip

Install the required packages.

pip install -r requirements.txt

If you want to build the docs using the same environment, then install the relevant dependencies.

pip install -r docs/requirements.txt

Testing

The testing is very simple. Just run the test.py file in the current Python virtual environment.

python test.py