Skip to content

Commit 78716d5

Browse files
docs: add Windows setup guide for new contributors
1 parent 43c0dfa commit 78716d5

1 file changed

Lines changed: 88 additions & 0 deletions

File tree

WINDOWS_SETUP.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Windows Setup Guide
2+
3+
To get setup for development on Windows, see
4+
[this video if you prefer VS Code](https://youtu.be/zddl3n1DCFM),
5+
or [this older video if you prefer PyCharm](https://youtu.be/QniQi-Hoo9A),
6+
and the instructions below.
7+
8+
## 1. Fork and clone this repo
9+
10+
Go to https://github.com/malariagen/malariagen-data-python
11+
and click the Fork button (top right corner).
12+
13+
Then in PowerShell run:
14+
```bash
15+
git clone https://github.com/[username]/malariagen-data-python.git
16+
cd malariagen-data-python
17+
```
18+
19+
## 2. Install Python
20+
21+
Download and install Python 3.10 from:
22+
https://www.python.org/downloads/windows/
23+
24+
> ⚠️ Important: During installation, check the box
25+
> "Add Python to PATH" before clicking Install.
26+
27+
Verify it worked:
28+
```bash
29+
python --version
30+
```
31+
32+
## 3. Install pipx and poetry
33+
```bash
34+
python -m pip install --user pipx
35+
python -m pipx ensurepath
36+
pipx install poetry
37+
```
38+
39+
> ⚠️ After running ensurepath, close and reopen
40+
> PowerShell before continuing.
41+
42+
## 4. Create and activate development environment
43+
```bash
44+
poetry install
45+
poetry shell
46+
```
47+
48+
## 5. Install pre-commit hooks
49+
```bash
50+
pipx install pre-commit
51+
pre-commit install
52+
```
53+
54+
## 6. Add upstream remote and get latest code
55+
```bash
56+
git remote add upstream https://github.com/malariagen/malariagen-data-python
57+
git pull upstream master
58+
```
59+
60+
> ℹ️ Note: On Windows the default branch is called
61+
> master not main.
62+
63+
## 7. Verify everything works
64+
```bash
65+
python -c "import malariagen_data; print('Setup successful!')"
66+
```
67+
68+
## Common Issues on Windows
69+
70+
**poetry not found after install**
71+
Close and reopen PowerShell, then try again.
72+
73+
**git not recognized**
74+
Install Git from https://git-scm.com/download/win
75+
and restart PowerShell.
76+
77+
**python not recognized**
78+
Reinstall Python and make sure to check
79+
"Add Python to PATH" during installation.
80+
81+
**fatal: not a git repository**
82+
Make sure you are inside the malariagen-data-python
83+
folder before running any git commands.
84+
Use: cd malariagen-data-python
85+
86+
**error: pathspec main did not match**
87+
On Windows use master instead of main.
88+
Run: git checkout master

0 commit comments

Comments
 (0)