The README contains a Getting started section that provides a high-level overview of how to get started with the project. After you've read that, you can continue here for more detailed information on how to contribute to the project.
Table of Contents
The project uses a uv lock file to pin its dependencies. We use the pinned versions in the lock file when building the project to ensure a consistent environment.
Dependency versions only ever change when we explictly update them with uv lock, which we will look at in the next section.
Most of the time, we only want to upgrade a single dependency. To do this, we can run the following command:
uv lock --upgrade-package <package>Sometimes, we want to upgrade to a specific version of a package:
uv lock --upgrade-package django==5.0.8Or, we can specify a range of versions to upgrade to:
uv lock --upgrade-package django>=5.0,<5.1We can also upgrade all dependencies at once:
uv lock --upgradeIt's useful to perform a dry-run first to see what changes will be made:
uv lock --upgrade --dry-runThe pyproject.toml file specifies minimum versions of dependencies, while the lock file pins the exact versions used in the project. You should only need to update the pyproject.toml file if you want to change the minimum version of a dependency.