Skip to content

Commit e02d5f7

Browse files
committed
Document Windows venv activation
1 parent be8b202 commit e02d5f7

3 files changed

Lines changed: 56 additions & 0 deletions

File tree

docs/install.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,20 @@ python3 -m venv .venv --prompt=dip-coater
1616
source .venv/bin/activate
1717
```
1818

19+
On Windows PowerShell:
20+
21+
```powershell
22+
py -m venv .venv --prompt dip-coater
23+
.\.venv\Scripts\Activate.ps1
24+
```
25+
26+
On Windows Command Prompt:
27+
28+
```bat
29+
py -m venv .venv --prompt dip-coater
30+
.venv\Scripts\activate.bat
31+
```
32+
1933
Upgrade pip (optional):
2034

2135
```bash
@@ -58,6 +72,10 @@ python3 -m pip install --upgrade pip
5872
python3 -m pip install -e .
5973
```
6074

75+
On Windows, use the same commands but activate the virtual environment with
76+
`.\.venv\Scripts\Activate.ps1` in PowerShell or `.venv\Scripts\activate.bat`
77+
in Command Prompt.
78+
6179
On a Raspberry Pi with GPIO hardware:
6280

6381
```bash
@@ -90,6 +108,18 @@ source .venv/bin/activate
90108
python3 -m pip install --upgrade dip-coater
91109
```
92110

111+
On Windows, activate the virtual environment with:
112+
113+
```powershell
114+
.\.venv\Scripts\Activate.ps1
115+
```
116+
117+
Or from Command Prompt:
118+
119+
```bat
120+
.venv\Scripts\activate.bat
121+
```
122+
93123
On a Raspberry Pi with GPIO hardware:
94124

95125
```bash

docs/troubleshooting.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,20 @@ source .venv/bin/activate
1717
dip-coater --help
1818
```
1919

20+
On Windows PowerShell:
21+
22+
```powershell
23+
.\.venv\Scripts\Activate.ps1
24+
dip-coater --help
25+
```
26+
27+
On Windows Command Prompt:
28+
29+
```bat
30+
.venv\Scripts\activate.bat
31+
dip-coater --help
32+
```
33+
2034
If you installed with uv, run:
2135

2236
```bash

src/test/test_docs_content.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ def test_install_docs_explain_software_updates_and_version_check():
66

77
assert "python3 -m pip install dip-coater" in install_docs
88
assert "python3 -m pip install --upgrade dip-coater" in install_docs
9+
assert ".\\.venv\\Scripts\\Activate.ps1" in install_docs
10+
assert ".venv\\Scripts\\activate.bat" in install_docs
911
assert "dip-coater --version" in install_docs
1012
assert "uv run dip-coater --version" in install_docs
1113
assert "## Source Checkout Install" in install_docs
@@ -68,6 +70,16 @@ def test_run_docs_explain_session_log_file():
6870
assert "JSON lines" in run_docs
6971

7072

73+
def test_troubleshooting_docs_include_windows_venv_activation():
74+
troubleshooting_docs = (
75+
Path(__file__).parents[2] / "docs" / "troubleshooting.md"
76+
).read_text()
77+
78+
assert "source .venv/bin/activate" in troubleshooting_docs
79+
assert ".\\.venv\\Scripts\\Activate.ps1" in troubleshooting_docs
80+
assert ".venv\\Scripts\\activate.bat" in troubleshooting_docs
81+
82+
7183
def test_python_examples_docs_reference_example_scripts():
7284
examples_docs = (
7385
Path(__file__).parents[2] / "docs" / "python-examples.md"

0 commit comments

Comments
 (0)