You will need the following installed on your system:
- Python 3.8+
- Pip
If you would like to update the api, please follow the instructions below.
-
Create a local virtual environment and activate it:
python -m venv .venv source .venv/bin/activate # linux .venv\Scripts\activate # windows
If you are using Anaconda, you can create a virtual environment with:
conda create -n fairhub-pipeline-dev-env python=3.11 conda activate fairhub-pipeline-dev-env
-
Install the dependencies:
pip install -r requirements.txt
-
Add your environment variables. An example is provided at
.env.example
cp .env.example .env
Make sure to update the values in
.env
to match your local setup. -
Format the code:
isort function_app.py black function_app.py
-
Check the code quality:
mypy function_app.py pylint function_app.py flake8 function_app.py
This work is licensed under MIT. See LICENSE for more information.