Skip to content

WINDOWS_SETUP.md

Latest commit

 

History

History
90 lines (66 loc) · 1.91 KB

WINDOWS_SETUP.md

File metadata and controls

90 lines (66 loc) · 1.91 KB

Windows Setup Guide

To get setup for development on Windows, see this video if you prefer VS Code, or this older video if you prefer PyCharm, and the instructions below.

1. Fork and clone this repo

git clone https://github.com/[username]/malariagen-data-python.git
cd malariagen-data-python

2. Install Python

Download and install Python 3.10 from the official website: https://www.python.org/downloads/windows/

During installation, check the box that says Add Python to PATH before clicking Install.

Verify the installation worked:

python --version

3. Install pipx and poetry

python -m pip install --user pipx
python -m pipx ensurepath
pipx install poetry

After running ensurepath, close and reopen PowerShell before continuing.

4. Create and activate development environment

poetry install
poetry shell

5. Install pre-commit hooks

pipx install pre-commit
pre-commit install

6. Add upstream remote and get latest code

git remote add upstream https://github.com/malariagen/malariagen-data-python
git pull upstream master

Note: On Windows the default branch is called master, not main.

7. Verify everything works

python -c "import malariagen_data; print('Setup successful!')"

Common Issues on Windows

poetry not found after install

Close and reopen PowerShell, then try again.

git not recognized

Install Git from https://git-scm.com/download/win and restart PowerShell.

python not recognized

Reinstall Python and make sure to check Add Python to PATH during installation.

fatal: not a git repository

Make sure you are inside the malariagen-data-python folder before running any git commands.

cd malariagen-data-python

error: pathspec main did not match

On Windows use master instead of main.

git checkout master