From 0337e06d810d99d36b46331c9a65d845bd891477 Mon Sep 17 00:00:00 2001 From: joelostblom Date: Fri, 8 Nov 2019 13:36:07 +0100 Subject: [PATCH 1/5] Make paths references consistent --- contributing.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/contributing.md b/contributing.md index 5634be34187..714213ca0e0 100644 --- a/contributing.md +++ b/contributing.md @@ -24,6 +24,7 @@ First, you'll need to *get* our project. This is the appropriate *clone* command ```bash git clone https://github.com/your_github_username/plotly.py.git +cd plotly.py ``` ### Create a virtual environment for plotly development @@ -32,15 +33,18 @@ TODO: Use virtualenv or conda, activate it http://docs.python-guide.org/en/latest/dev/virtualenvs/ ### Install requirements - $ pip install -r requirements.txt - $ pip install -r optional-requirements.txt + + $ pip install -r packages/python/plotly/requirements.txt + $ pip install -r packages/python/plotly/optional-requirements.txt ### Editable install of plotly packages + $ pip install -e packages/python/plotly/ $ pip install -e packages/python/chart-studio/ $ pip install -e packages/python/plotly-geo/ ### ipywidgets development install + Run the following commands in your virtual environment to use the development version of `FigureWidget`, From 1a50029932fb8352c7c84cbe8e9c9b76ae2b9675 Mon Sep 17 00:00:00 2001 From: joelostblom Date: Fri, 8 Nov 2019 13:36:54 +0100 Subject: [PATCH 2/5] Add virtual environment instructions --- contributing.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/contributing.md b/contributing.md index 714213ca0e0..bd6c2ed3353 100644 --- a/contributing.md +++ b/contributing.md @@ -28,9 +28,16 @@ cd plotly.py ``` ### Create a virtual environment for plotly development -TODO: Use virtualenv or conda, activate it -http://docs.python-guide.org/en/latest/dev/virtualenvs/ +You can use either [conda][conda-env] or [virtualenv][virtualenv] to create a virtual environment for plotly development, e.g. + +```bash +conda create -n plotly-dev python +conda activate plotly-dev +``` + +[conda-env]: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands +[virtualenv]: http://docs.python-guide.org/en/latest/dev/virtualenvs/ ### Install requirements From 5a3d1e45ff77725d3c8e853ad01cf984ebd610c6 Mon Sep 17 00:00:00 2001 From: joelostblom Date: Fri, 8 Nov 2019 13:37:09 +0100 Subject: [PATCH 3/5] Add note on jupyterlab --- contributing.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index bd6c2ed3353..1c672202918 100644 --- a/contributing.md +++ b/contributing.md @@ -58,7 +58,11 @@ development version of `FigureWidget`, $ jupyter nbextension enable --py widgetsnbextension $ jupyter nbextension install --py --symlink --sys-prefix plotlywidget $ jupyter nbextension enable --py --sys-prefix plotlywidget - + +To make plotly plots show up in JupyterLab, you also need to [install the plotly jupyterlab extensions][plotly-jl]. + +[plotly-jl]: https://plot.ly/python/getting-started/#jupyterlab-support-python-35 + ### Setup Submodules 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: From ed35d34622e80172aaeaea66a4aec33e53ee500c Mon Sep 17 00:00:00 2001 From: joelostblom Date: Fri, 8 Nov 2019 13:37:29 +0100 Subject: [PATCH 4/5] Correct submodules file name --- contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index 1c672202918..57d50ed26b1 100644 --- a/contributing.md +++ b/contributing.md @@ -70,7 +70,7 @@ This project uses git submodules. They're both helpful and, at times, difficult **DO THIS (run this command in your new `plotly.py` directory)** ```bash -python update_submodules.py +python setup_submodules.py ``` 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. From 23a56d5825ad78cc479fa21ad7d963922ca563c8 Mon Sep 17 00:00:00 2001 From: joelostblom Date: Fri, 8 Nov 2019 13:38:07 +0100 Subject: [PATCH 5/5] Fix dead link --- contributing.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/contributing.md b/contributing.md index 57d50ed26b1..25d81839198 100644 --- a/contributing.md +++ b/contributing.md @@ -535,4 +535,6 @@ From `packages/python/plotly-geo`, build the conda packge Then upload to the plotly anaconda channel as described above ## Contributing to the Figure Factories -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. +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. + +[ff-home]: packages/python/plotly/plotly/figure_factory/README.md