From 1b190768ebfd1bcea2a5971a0621f61056e99485 Mon Sep 17 00:00:00 2001 From: NikolaiKryshnev <63440682+NikolaiKryshnev@users.noreply.github.com> Date: Sat, 16 Aug 2025 14:10:24 +0300 Subject: [PATCH] docs: add developer setup instructions for Windows --- docs/README-windows.md | 56 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 54 insertions(+), 2 deletions(-) diff --git a/docs/README-windows.md b/docs/README-windows.md index 0c20c03d16..33f066742e 100644 --- a/docs/README-windows.md +++ b/docs/README-windows.md @@ -1,7 +1,59 @@ + # web3.py on Windows ## Developer Setup -1. Install all of the package dependencies (TODO) +### Option 1: Native Windows setup + +1. **Install Python 3.9+** + Download from [python.org](https://www.python.org/downloads/windows/). + Make sure to check **"Add Python to PATH"** during installation. + +2. **Clone the repository and create a virtual environment**: + +```powershell +cd %USERPROFILE% +```` +```powershell +git clone https://github.com/ethereum/web3.py.git +```` +```powershell +cd web3.py +```` +```powershell +python -m venv venv +```` +```powershell +venv\Scripts\activate +```` + +3. **Upgrade pip and install development dependencies**: + +```powershell +pip install --upgrade pip +``` +```powershell +pip install -e ".[dev]" +``` + +4. **(Optional) Install `leveldb` binaries if needed**: + +```powershell +pip install plyvel-binary +``` + +> ⚠️ Note: `leveldb` is not required for most users. +> If installation fails, you can safely skip this step. + +--- + +### Option 2: Recommended (via WSL) + +Many Ethereum developers prefer using +[WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install) +to avoid dependency issues. + +With WSL you can run a Linux distribution (Ubuntu/Debian/Fedora, etc.) directly on Windows. +After installing WSL, follow the Linux setup guide: [README-linux.md](./README-linux.md). -1. Install `leveldb` (TODO) +---