DEVELOP.md

This file contains instructions for developers who want to contribute to the project.

It includes information on how to set up the development environment, run tests, and format code.

Install pyenv and download Python 3.11.2

pyenv install 3.11.2
pyenv local 3.11.2

To create a virtual environment:

python3 -m venv venv

To use pre-commit hooks locally, install pre-commit:

pip install pre-commit
pre-commit install

To format code

Install dependencies:

pip install black isort flake8

Run the following command (in the root directory of the project):

chmod +x format-all.sh
./format-all.sh

To run tests using pytest

Install dependencies:

pip install pytest

Run the following command (in the root directory of the project):

pytest