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:
uv self update uv venv uv python install 3.14t uv pip install -r requirements.txt
If you are using pyenv, you can create a virtual environment with:
python -m venv .venv source .venv/bin/activate # linux .venv\Scripts\activate # windows
-
Install the dependencies:
uv pip install -r requirements.txt pip install -r requirements.txt
-
Add your environment variables. An example is provided at
.env.examplecp .env.example .env
Make sure to update the values in
.envto match your local setup. -
Format the code:
poe format_with_isort poe format_with_black
You can also run
poe formatto run both commands at once. -
Check the code quality:
poe typecheck poe pylint poe flake8
You can also run
poe lintto run all three commands at once. -
To start the local server, run:
poe init # pick python poe devThis runs
func startwith the--pythonflag. -
To run code with Python GIL disabled, run:
python -X gil=0 .\garmin_pipeline_local.py
This work is licensed under MIT. See LICENSE for more information.