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
The Linux, Mac, and Windows specific guides are out of date. Combine
them into the main guide so we don't duplicate any information and
can keep everything in one place.
Also:
- update the pre-commit hook version to avoid a warning
- update the gcloud install script to latest Google instructions
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+34-13Lines changed: 34 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,35 @@ You'll need:
15
15
-[pipx](https://pipx.pypa.io/) for installing Python tools
16
16
-[git](https://git-scm.com/) for version control
17
17
18
-
Both of these can be installed using your distribution's package manager or [Homebrew](https://brew.sh/) on Mac.
18
+
Both of these can be installed using your distribution's package manager or [Homebrew](https://brew.sh/) on Mac. On Windows we recommend development on Linux using [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install). For example,
19
+
20
+
**Ubuntu, Debian, and Mint:**
21
+
22
+
```bash
23
+
sudo apt install -y git pipx
24
+
pipx ensurepath
25
+
```
26
+
27
+
**Fedora:**
28
+
29
+
```bash
30
+
sudo dnf install -y git pipx
31
+
pipx ensurepath
32
+
```
33
+
34
+
**Arch Linux:**
35
+
36
+
```bash
37
+
sudo pacman -S git pipx
38
+
pipx ensurepath
39
+
```
40
+
41
+
**Mac**
42
+
43
+
```bash
44
+
brew install git pipx
45
+
pipx ensurepath
46
+
```
19
47
20
48
### Initial setup
21
49
@@ -55,27 +83,20 @@ Both of these can be installed using your distribution's package manager or [Hom
55
83
poetry install --with dev,test,docs
56
84
```
57
85
58
-
This installs the runtime dependencies along with the `dev`, `test`, and `docs`
This installs the runtime dependencies along with the `dev`, `test`, and `docs`[dependency groups](https://python-poetry.org/docs/managing-dependencies/#dependency-groups).
60
87
If you only need to run tests, `poetry install --with test` is sufficient.
61
88
62
-
**Recommended**: Use`poetry run` to run commands inside the virtual environment:
89
+
You can use`poetry run` to run commands inside the virtual environment:
63
90
64
91
```bash
65
92
poetry run pytest
66
93
poetry run python script.py
67
94
```
68
95
69
-
**Optional**: If you prefer an interactive shell session, install the shell plugin first:
70
-
71
-
```bash
72
-
poetry self add poetry-plugin-shell
73
-
```
74
-
75
-
Then activate the environment with:
96
+
Alternatively, if you prefer an interactive shell session, activate the environment using:
76
97
77
98
```bash
78
-
poetry shell
99
+
eval$(poetry env activate)
79
100
```
80
101
81
102
After activation, commands run directly inside the virtual environment:
@@ -147,7 +168,7 @@ Both of these can be installed using your distribution's package manager or [Hom
147
168
poetry run pytest -v tests/integration
148
169
```
149
170
150
-
Tests will run slowly the first time, as data required for testing will be read from GCS. Subsequent runs will be faster as data will be cached locally in the "gcs_cache" folder.
171
+
Tests will run slowly the first time, as data required for testing will be read from GCS. Subsequent runs will be faster as data will be cached locally in the `gcs_cache` folder.
Copy file name to clipboardExpand all lines: README.md
-5Lines changed: 0 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,11 +46,6 @@ for release notes.
46
46
47
47
To get setup for development, see [this video if you prefer VS Code](https://youtu.be/zddl3n1DCFM), or [this older video if you prefer PyCharm](https://youtu.be/QniQi-Hoo9A).
0 commit comments