Skip to content

Commit a8009a8

Browse files
authored
Merge pull request #774 from alimanfoo/readme-2025-05-13
Readme updates and new dev setup video
2 parents 1cba09b + a05ac61 commit a8009a8

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ for release notes.
3535

3636
## Developer setup
3737

38-
To get setup for development, see [this
39-
video](https://youtu.be/QniQi-Hoo9A) and the instructions below.
38+
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), and the instructions below.
4039

4140
Fork and clone this repo:
4241

@@ -48,27 +47,27 @@ Install Python, e.g.:
4847

4948
```bash
5049
sudo add-apt-repository ppa:deadsnakes/ppa
51-
sudo apt install python3.9 python3.9-venv
50+
sudo apt install python3.10 python3.10-venv
5251
```
5352

5453
Install pipx, e.g.:
5554

5655
```bash
57-
python3.9 -m pip install --user pipx
58-
python3.9 -m pipx ensurepath
56+
python3.10 -m pip install --user pipx
57+
python3.10 -m pipx ensurepath
5958
```
6059

6160
Install [poetry](https://python-poetry.org/docs/#installation), e.g.:
6261

6362
```bash
64-
pipx install poetry==1.8.2 --python=/usr/bin/python3.9
63+
pipx install poetry
6564
```
6665

6766
Create development environment:
6867

6968
```bash
7069
cd malariagen-data-python
71-
poetry use 3.9
70+
poetry use 3.10
7271
poetry install
7372
```
7473

@@ -81,7 +80,7 @@ poetry shell
8180
Install pre-commit and pre-commit hooks:
8281

8382
```bash
84-
pipx install pre-commit --python=/usr/bin/python3.9
83+
pipx install pre-commit
8584
pre-commit install
8685
```
8786

@@ -97,7 +96,9 @@ Run fast unit tests using simulated data:
9796
poetry run pytest -v tests/anoph
9897
```
9998

100-
To run legacy tests which read data from GCS, you'll need to [install the Google Cloud CLI](https://cloud.google.com/sdk/docs/install). E.g., if on Linux:
99+
To run legacy tests which read data from GCS, you'll need to [request access to MalariaGEN data on GCS](https://malariagen.github.io/vector-data/vobs/vobs-data-access.html).
100+
101+
Once access has been granted, [install the Google Cloud CLI](https://cloud.google.com/sdk/docs/install). E.g., if on Linux:
101102

102103
```bash
103104
./install_gcloud.sh

0 commit comments

Comments
 (0)