1- # Windows Setup Guide
1+ Windows Setup Guide
22
33To get setup for development on Windows, see
44[ this video if you prefer VS Code] ( https://youtu.be/zddl3n1DCFM ) ,
55or [ this older video if you prefer PyCharm] ( https://youtu.be/QniQi-Hoo9A ) ,
66and the instructions below.
77
8- ## 1. Fork and clone this repo
8+ 1 . Fork and clone this repo
99
1010Go to https://github.com/malariagen/malariagen-data-python
1111and click the Fork button (top right corner).
@@ -16,7 +16,7 @@ git clone https://github.com/[username]/malariagen-data-python.git
1616cd malariagen-data-python
1717```
1818
19- ## 2. Install Python
19+ 2 . Install Python
2020
2121Download and install Python 3.10 from:
2222https://www.python.org/downloads/windows/
@@ -29,7 +29,7 @@ Verify it worked:
2929python --version
3030```
3131
32- ## 3. Install pipx and poetry
32+ 3 . Install pipx and poetry
3333``` bash
3434python -m pip install --user pipx
3535python -m pipx ensurepath
@@ -39,19 +39,19 @@ pipx install poetry
3939> ⚠️ After running ensurepath, close and reopen
4040> PowerShell before continuing.
4141
42- ## 4. Create and activate development environment
42+ 4 . Create and activate development environment
4343``` bash
4444poetry install
4545poetry shell
4646```
4747
48- ## 5. Install pre-commit hooks
48+ 5 . Install pre-commit hooks
4949``` bash
5050pipx install pre-commit
5151pre-commit install
5252```
5353
54- ## 6. Add upstream remote and get latest code
54+ 6 . Add upstream remote and get latest code
5555``` bash
5656git remote add upstream https://github.com/malariagen/malariagen-data-python
5757git pull upstream master
@@ -60,29 +60,29 @@ git pull upstream master
6060> ℹ️ Note: On Windows the default branch is called
6161> master not main.
6262
63- ## 7. Verify everything works
63+ 7 . Verify everything works
6464``` bash
6565python -c " import malariagen_data; print('Setup successful!')"
6666```
6767
68- ## Common Issues on Windows
68+ Common Issues on Windows
6969
70- ** poetry not found after install**
70+ poetry not found after install
7171Close and reopen PowerShell, then try again.
7272
73- ** git not recognized**
73+ git not recognized
7474Install Git from https://git-scm.com/download/win
7575and restart PowerShell.
7676
77- ** python not recognized**
77+ python not recognized
7878Reinstall Python and make sure to check
7979"Add Python to PATH" during installation.
8080
81- ** fatal: not a git repository**
81+ fatal: not a git repository
8282Make sure you are inside the malariagen-data-python
8383folder before running any git commands.
8484Use: cd malariagen-data-python
8585
86- ** error: pathspec main did not match**
86+ error: pathspec main did not match
8787On Windows use master instead of main.
88- Run: git checkout master
88+ Run: git checkout master
0 commit comments