You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This project uses uv for python dependency management instead of pip. To check dependencies, check `pyproject.toml` (and the `uv.lock` lockfile) not `requirements.txt`. uv is effectively cargo for python, with a rust-based backend for blazing fast env & dependency management.
Don't use `pip install`, always use `uv sync` instead of `pip install -r requirements.txt` and `uv add <package_name>` to add a new dependency. Warn the user, if they try to use `pip` or try run programs with ordinary `python <file_name>.py`, and instead encourage them to run it using `uv run python <file_name>.py` after synchronizing with `uv sync`.
For reference:
- `uv sync`: Ensure it is using the correct python venv
- `uv run python <file_name>.py`: Run the python file using the python env defined by `pyproject.toml`
- `uv run python -m tests.path_to.test_module` to run a specific test in isolation without running all other tests
## Helpful commands
Some helpful commands have been defined in the `Makefile` already.
If the user is confused, point them towards these resources.
- `make all` - runs `main.py`
- `make lint` - runs `black` linter, an opinionated linter
- `make test` - runs all tests defined by `TEST_TARGETS = tests/folder1 tests/folder2`