Skip to content

Commit 327ab21

Browse files
Added Windows development workflow to CONTRIBUTING.md (#147)
* DOC: add Windows development workflow to CONTRIBUTING.md * DOC: add Windows development workflow to CONTRIBUTING.md * updated window's instructions --------- Co-authored-by: Aditi Juneja <91629733+Schefflera-Arboricola@users.noreply.github.com>
1 parent 344fa88 commit 327ab21

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ python -m venv nxp-dev
2323

2424
# Activating the venv
2525
source nxp-dev/bin/activate
26+
27+
# For Windows
28+
.\nxp-dev\Scripts\Activate.ps1
2629
```
2730

2831
- Install the dependencies using the following command
@@ -31,6 +34,14 @@ source nxp-dev/bin/activate
3134
make install
3235
```
3336

37+
`make` commands aren't supported on Windows-- so use the commands below instead:
38+
39+
```powershell
40+
pip install -e ".[test]"
41+
pip install git+https://github.com/networkx/networkx.git@main
42+
pip install git+https://github.com/joblib/joblib.git@main
43+
```
44+
3445
- Create a new branch for your changes using
3546

3647
```.sh
@@ -48,11 +59,26 @@ git checkout -b <branch_name>
4859
```.sh
4960
make run-networkx-tests
5061
```
62+
63+
- For Windows:
64+
65+
```powershell
66+
$env:NETWORKX_TEST_BACKEND="parallel";
67+
$env:NETWORKX_FALLBACK_TO_NX="True";
68+
pytest --pyargs networkx/
69+
70+
# linters
71+
pip install -e ".[developer]"
72+
pre-commit run --all-files
73+
```
5174
5275
- To only run nx-parallel specific tests run:
5376
5477
```.sh
5578
make test-only-nx-parallel
79+
80+
# With Windows:
81+
pytest nx_parallel
5682
```
5783
5884
- To run both nx-parallel specific test and networkx's test suite with the parallel backend run:

0 commit comments

Comments
 (0)