Skip to content

Commit e5eb9bc

Browse files
authored
Update contributing quick reference with uv-based instructions. (#5)
Update contributing quick reference with uv-based instructions.
1 parent 8c1c0d3 commit e5eb9bc

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

content/contributing/quick.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ $ git switch -c short-descriptive-name
3232

3333
## Install Development Dependencies
3434

35+
Projects are being converted to use `uv`. The easy way to identify if that has occurred
36+
is the existence, or not, of a `requirements` directory in root pf the project.
37+
38+
### Projects with a `requirements` directory
39+
3540
Create a virtualenv and activate it. Install the dev dependencies, and the
3641
project in editable mode. Install the pre-commit hooks.
3742

@@ -60,6 +65,35 @@ Any time you open a new terminal, you need to activate the virtualenv again. If
6065
you've pulled from upstream recently, you can re-run the `pip` command above to
6166
get the current dev dependencies.
6267

68+
69+
### Projects without a `requirements` directory
70+
71+
[Install `uv`.][uv]
72+
73+
[uv]: https://docs.astral.sh/uv/getting-started/installation/
74+
75+
Install dev dependencies:
76+
77+
```
78+
$ uv sync
79+
```
80+
81+
Activate the virtualenv (Mac and Linux):
82+
83+
```
84+
$ . .venv/bin/activate
85+
```
86+
87+
Activate the virtualenv (Windows):
88+
89+
```
90+
> .\.venv\Scripts\activate
91+
```
92+
93+
Any time you open a new terminal, you need to activate the virtualenv again. If
94+
you've pulled from upstream recently, you can re-run the `uv sync` command to
95+
get the current dev dependencies.
96+
6397
## Run Tests
6498

6599
These are the essential test commands you can run while developing:

0 commit comments

Comments
 (0)