A complete guide to setup your development environment :D
python 3.10
Make sure you also already installed pip and venv for your Python
Start by creating your isolated Python environment with venv:
$ python3 -m venv .venvIn this case, .venv is the name of the directory containing your Python executable and other files. You can name it anything you want, but .venv is the most common name.
Next, activate your virutal environment:
$ source .venv/bin/activateYou can verify your virutal environment is properly activated by running python -V which will either have your regular path (incorrectly activated) or your virutal environment path (correctly activated).
You will notice there are 2 files named requirements-dev.txt and requirements.txt. These files contain the name of the pip packages.
requirements-dev.txt contains the packages needed to enhance developer's experience. While requirements.txt contains the packages needed for the application to run.
Install all of these by running:
pip install -r requirements-dev.txt
pip install -r requirements.txtInorder to make sure the codebase is clean and the style is consistent between many developers, we use a few lint tools to detect and auto-fix (if possible). These can be found in .pre-commit-config.yaml.
To install git hooks in your .git directory, run:
pre-commit install
These lint tools will be run when you commit your code and you can only successfully commit if . You can also run it without commiting: pre-commit run --all-files