Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d8b9fc2

Browse files
joelostblomjonmmease
authored andcommittedDec 10, 2019
Update contribution guidelines (#1884)
* Make paths references consistent * Add virtual environment instructions * Add note on jupyterlab * Correct submodules file name * Fix dead link
1 parent 97e4378 commit d8b9fc2

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed
 

‎contributing.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,38 +24,53 @@ First, you'll need to *get* our project. This is the appropriate *clone* command
2424

2525
```bash
2626
git clone https://github.com/your_github_username/plotly.py.git
27+
cd plotly.py
2728
```
2829

2930
### Create a virtual environment for plotly development
30-
TODO: Use virtualenv or conda, activate it
3131

32-
http://docs.python-guide.org/en/latest/dev/virtualenvs/
32+
You can use either [conda][conda-env] or [virtualenv][virtualenv] to create a virtual environment for plotly development, e.g.
33+
34+
```bash
35+
conda create -n plotly-dev python
36+
conda activate plotly-dev
37+
```
38+
39+
[conda-env]: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands
40+
[virtualenv]: http://docs.python-guide.org/en/latest/dev/virtualenvs/
3341

3442
### Install requirements
35-
$ pip install -r requirements.txt
36-
$ pip install -r optional-requirements.txt
43+
44+
$ pip install -r packages/python/plotly/requirements.txt
45+
$ pip install -r packages/python/plotly/optional-requirements.txt
3746

3847
### Editable install of plotly packages
48+
3949
$ pip install -e packages/python/plotly/
4050
$ pip install -e packages/python/chart-studio/
4151
$ pip install -e packages/python/plotly-geo/
4252

4353
### ipywidgets development install
54+
4455
Run the following commands in your virtual environment to use the
4556
development version of `FigureWidget`,
4657

4758
$ jupyter nbextension enable --py widgetsnbextension
4859
$ jupyter nbextension install --py --symlink --sys-prefix plotlywidget
4960
$ jupyter nbextension enable --py --sys-prefix plotlywidget
50-
61+
62+
To make plotly plots show up in JupyterLab, you also need to [install the plotly jupyterlab extensions][plotly-jl].
63+
64+
[plotly-jl]: https://plot.ly/python/getting-started/#jupyterlab-support-python-35
65+
5166
### Setup Submodules
5267

5368
This project uses git submodules. They're both helpful and, at times, difficult to work with. The good news is you probably don't need to think about them! Just run the following shell command to make sure that your local repo is wired properly:
5469

5570
**DO THIS (run this command in your new `plotly.py` directory)**
5671

5772
```bash
58-
python update_submodules.py
73+
python setup_submodules.py
5974
```
6075

6176
That's going to initialize the submodules we use in this project, update them so that they're synced to the proper commit, and copy files to the appropriate locations in your local repo.
@@ -520,4 +535,6 @@ From `packages/python/plotly-geo`, build the conda packge
520535
Then upload to the plotly anaconda channel as described above
521536

522537
## Contributing to the Figure Factories
523-
If you are interested in contributing to the ever-growing Plotly figure factory library in Python, check out the [documentation](https://github.com/plotly/plotly.py/blob/master/plotly/figure_factory/README.md) to learn how.
538+
If you are interested in contributing to the ever-growing Plotly figure factory library in Python, check out the [documentation][ff-home] to learn how.
539+
540+
[ff-home]: packages/python/plotly/plotly/figure_factory/README.md

0 commit comments

Comments
 (0)
Please sign in to comment.