You will need the following installed on your system:
- mise — manages Python and uv versions
-
Install project tooling (Python 3.11 + uv) via mise:
mise trust # only needed the first time mise installmise will automatically create a virtual environment via uv (
uv_venv_auto = true). -
Install the dependencies:
uv pip install -r requirements.txt uv run xxx.py # Always use 'uv run' — never bare 'python xxx.py' -
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:
uv run python -X gil=0 .\garmin_pipeline_local.py
This work is licensed under MIT. See LICENSE for more information.