Skip to content

Commit c7c4181

Browse files
authored
Update contributing.md for Windows contributors
Went through the steps on my Windows development machine and ran into errors (below). Discovered that this was likely Windows specific and wanted to simply update this so others can avoid similar issues. Also updated some of the bash commands so that they highlighted having an activated virtual environment for consistency. Complete output (1 lines): A GDAL API version must be specified. Provide a path to gdal-config using a GDAL_CONFIG environment variable or use a GDAL_VERSION environment variable. ---------------------------------------- ERROR: Command errored out with exit status 1: python setup.py egg_info Check the logs for full command output.
1 parent 4021682 commit c7c4181

File tree

1 file changed

+23
-13
lines changed

1 file changed

+23
-13
lines changed

Diff for: contributing.md

+23-13
Original file line numberDiff line numberDiff line change
@@ -128,17 +128,27 @@ conda activate plotly-dev
128128
[conda-env]: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands
129129
[virtualenv]: http://docs.python-guide.org/en/latest/dev/virtualenvs/
130130

131-
### Install requirements
131+
### Install requirements - (Non-Windows)
132+
```bash
133+
(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
134+
(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
135+
```
136+
### Install requirements - (Windows + Conda)
137+
Because Windows requires Visual Studio libraries to compile some of the optional dependencies, follow these steps to
138+
complete installation and avoid gdal-config errors.
132139

133-
$ pip install -r packages/python/plotly/requirements.txt
134-
$ pip install -r packages/python/plotly/optional-requirements.txt
140+
```bash
141+
(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
142+
(plotly_dev) $ conda install fiona
143+
(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
144+
```
135145

136146
### Editable install of plotly packages
137-
138-
$ pip install -e packages/python/plotly/
139-
$ pip install -e packages/python/chart-studio/
140-
$ pip install -e packages/python/plotly-geo/
141-
147+
```bash
148+
(plotly_dev) $ pip install -e packages/python/plotly/
149+
(plotly_dev) $ pip install -e packages/python/chart-studio/
150+
(plotly_dev) $ pip install -e packages/python/plotly-geo/
151+
```
142152
This will ensure that the installed packages links to your local development
143153
directory, meaning that all changes you make reflect directly in your
144154
environment (don't forget to restart the Jupyter kernel though!).
@@ -147,11 +157,11 @@ environment (don't forget to restart the Jupyter kernel though!).
147157

148158
Run the following commands in your virtual environment to use the
149159
development version of `FigureWidget`,
150-
151-
$ jupyter nbextension enable --py widgetsnbextension
152-
$ jupyter nbextension install --py --symlink --sys-prefix plotlywidget
153-
$ jupyter nbextension enable --py --sys-prefix plotlywidget
154-
160+
```bash
161+
(plotly_dev) $ jupyter nbextension enable --py widgetsnbextension
162+
(plotly_dev) $ jupyter nbextension install --py --symlink --sys-prefix plotlywidget
163+
(plotly_dev) $ jupyter nbextension enable --py --sys-prefix plotlywidget
164+
```
155165
To make plotly plots show up in JupyterLab, you also need to [install the plotly jupyterlab extensions][plotly-jl].
156166

157167
[plotly-jl]: https://plot.ly/python/getting-started/#jupyterlab-support-python-35

0 commit comments

Comments
 (0)