From 5df126f4959bb2ebf1945c33d2fa03a7603149ca Mon Sep 17 00:00:00 2001 From: Nicholas Esterer Date: Mon, 8 Jun 2020 12:43:23 -0400 Subject: [PATCH 1/2] Clarified installation process for development Included the words "install from source" and links to documentation on pip -e and setuptool's "developer mode". --- contributing.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/contributing.md b/contributing.md index c4e66408068..36ccb865a5c 100644 --- a/contributing.md +++ b/contributing.md @@ -64,7 +64,7 @@ the structure of the code and of the repository. https://github.com/plotly/plotly.py/issues/1965. If you have writing skills, the wording of existing examples can also be improved in places. -Contributing code or documentation are not the only way to contribute! You can +Contributing code or documentation is not the only way to contribute! You can also contribute to the project by - reporting bugs (see below). @@ -133,15 +133,20 @@ conda activate plotly-dev $ pip install -r packages/python/plotly/requirements.txt $ pip install -r packages/python/plotly/optional-requirements.txt -### Editable install of plotly packages +### Editable install of plotly packages (install from source) $ pip install -e packages/python/plotly/ $ pip install -e packages/python/chart-studio/ $ pip install -e packages/python/plotly-geo/ -This will ensure that the installed packages links to your local development +This will ensure that the installed packages link to your local development directory, meaning that all changes you make reflect directly in your -environment (don't forget to restart the Jupyter kernel though!). +environment (don't forget to restart the Jupyter kernel though!). For more +information see the +[`setuptools`](https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode) +and +[`pip`](https://pip.pypa.io/en/stable/reference/pip_install/#install-editable) +documentation on _development mode_. ### ipywidgets development install From ff7f1b4564ee0ab5d4b3561fb4a6b1329e1f9c0a Mon Sep 17 00:00:00 2001 From: Nicholas Esterer Date: Mon, 8 Jun 2020 15:31:27 -0400 Subject: [PATCH 2/2] black now included in packages/python/plotly/optional-requirements.txt As it says in contributing.md --- packages/python/plotly/optional-requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/python/plotly/optional-requirements.txt b/packages/python/plotly/optional-requirements.txt index 9886dcd1872..1fcf7939d9b 100644 --- a/packages/python/plotly/optional-requirements.txt +++ b/packages/python/plotly/optional-requirements.txt @@ -25,6 +25,7 @@ psutil ## code formatting pre-commit +black ## codegen dependencies ## inflect