Merge branch 'main' into merge-docs-changes-to-main

Author: LiamConnors

.circleci/config.yml

@@ -7,7 +7,7 @@ below :-).
 ### Documentation PR
 
 - [ ] I've [seen the `doc/README.md` file](https://github.com/plotly/plotly.py/blob/master/doc/README.md)
-- [ ] This change runs in the current version of Plotly on PyPI and targets the `doc-prod` branch OR it targets the `master` branch
+- [ ] This change runs in the current version of Plotly on PyPI and targets the `doc-prod` branch OR it targets the `main` branch
 - [ ] If this PR modifies the first example in a page or adds a new one, it is a `px` example if at all possible
 - [ ] Every new/modified example has a descriptive title and motivating sentence or paragraph
 - [ ] Every new/modified example is independently runnable
@@ -27,7 +27,7 @@ below :-).
 
 ## Code PR
 
-- [ ] I have read through the [contributing notes](https://github.com/plotly/plotly.py/blob/master/contributing.md) and understand the structure of the package. In particular, if my PR modifies code of `plotly.graph_objects`, my modifications concern the `codegen` files and not generated files.
+- [ ] I have read through the [contributing notes](https://github.com/plotly/plotly.py/blob/master/CONTRIBUTING.md) and understand the structure of the package. In particular, if my PR modifies code of `plotly.graph_objects`, my modifications concern the `codegen` files and not generated files.
 - [ ] I have added tests (if submitting a new feature or correcting a bug) or
   modified existing tests.
 - [ ] For a new feature, I have added documentation examples in an existing or

.flake8

@@ -1,7 +1,7 @@
 0
 0.html
 iframe_figures/
-packages/python/plotly/plotly/tests/test_orca/images/linux/failed/
+tests/test_orca/images/linux/failed/
 
 *.egg-info
 
@@ -15,6 +15,7 @@ doc/python/raw.githubusercontent.com/
 
 # Don't ignore dataset files
 !*.csv.gz
+!*.geojson.gz
 
 *.ipynb
 
@@ -48,21 +49,17 @@ plotly.egg-info/
 # macOS utility file
 **/.DS_Store
 
-plotly/tests/test_orca/images/*/failed
-plotly/tests/test_orca/images/*/tmp
-/plotly-package/plotly/tests/test_core/test_offline/plotly.min.js
+tests/test_orca/images/*/failed
+tests/test_orca/images/*/tmp
+tests/test_core/test_offline/plotly.min.js
 temp-plot.html
 .vscode
 doc/python/.ipynb_checkpoints
 doc/python/.mapbox_token
 doc/.ipynb_checkpoints
 tags
 doc/check-or-enforce-order.py
+plotly/package_data/widgetbundle.js
 
-packages/javascript/jupyterlab-plotly/lib/
-packages/python/plotly/jupyterlab_plotly/labextension/
-packages/python/plotly/jupyterlab_plotly/nbextension/index.js*
-packages/python/plotly/plotly/package_data/widgetbundle.js
-
-test/percy/*.html
-test/percy/pandas2/*.html
+tests/percy/*.html
+tests/percy/pandas2/*.html

.gitattributes

@@ -716,7 +716,7 @@ This version includes several performance improvements ([#2368](https://github.c
     - Introduce range breaks on date axes (for example, to remove week-ends) via `layout.xaxis.rangebreaks`
     - Introduce a new unified x (or y) hovermode (`layout.hovermode="x unified"`), in which the hover box shows the information for all traces at a given x (or y) position
     - Add `node.customdata` and `link.customdata` to sankey traces
-- Updated [contributing notes](https://github.com/plotly/plotly.py/blob/master/contributing.md) for more explanations on how to contribute to plotly.py [#2290](https://github.com/plotly/plotly.py/pull/2290). Please give feedback on these notes!
+- Updated [contributing notes](https://github.com/plotly/plotly.py/blob/master/CONTRIBUTING.md) for more explanations on how to contribute to plotly.py [#2290](https://github.com/plotly/plotly.py/pull/2290). Please give feedback on these notes!
 - Updated documentation examples [#2325](https://github.com/plotly/plotly.py/pull/2325), and to show how to color links in Sankey diagrams [#2291](https://github.com/plotly/plotly.py/pull/2291).
 - Special thanks to [@SylwiaOliwia2](https://github.com/SylwiaOliwia2) and [@dangercrow](https://github.com/dangercrow) for improving our documentation!
 
@@ -1738,7 +1738,7 @@ This is a major version with many exciting updates. See the [Introducing plotly.
 - Error message for `plotly.figure_factory.create_choropleth` is now helpful to Anaconda users who do not have the correct modules installed for the County Choropleth figure factory.
 
 ### Changed / Deprecated
-Please see the [migration guid](migration-guide.md) for a full list of the changes and deprecations in version 3.0.0
+Please see the [migration guide](MIGRATION_GUIDE.md) for a full list of the changes and deprecations in version 3.0.0
 
 
 

.github/pull_request_template.md

@@ -20,14 +20,14 @@ There are many ways to contribute to plotly.py. To contribute effectively, it is
   is [generated from the Plotly.js schema](https://plotly.com/python/figure-structure/),
   so changes to be made in this package need to be
   [contributed to Plotly.js](https://github.com/plotly/plotly.js) or to the `codegen` system
-  in `packages/python/plotly/codegen`. Most of the codegen code concerns the generation of docstrings from
+  in `codegen/`. Most of the codegen code concerns the generation of docstrings from
   the schema JSON in Plotly.js. Traces and
   Layout classes have a direct correspondence with their Javascript
-  counterpart. Higher-level methods that work on figures regardless of the current schema (e.g., `BaseFigure.for_each_trace`) are defined in `packages/python/plotly/plotly/basedatatypes.py`. Additional helper methods are defined there for the `Figure` object, such as
+  counterpart. Higher-level methods that work on figures regardless of the current schema (e.g., `BaseFigure.for_each_trace`) are defined in `plotly/basedatatypes.py`. Additional helper methods are defined there for the `Figure` object, such as
   `update_layout`, `add_trace`, etc.
 
 - [the `plotly.express` module](https://plotly.com/python/plotly-express/) (usually imported as `px`) is a high-level
-  functional API that uses `graph_objects` under the hood. Its code is in `packages/python/plotly/plotly/express`.
+  functional API that uses `graph_objects` under the hood. Its code is in `plotly/express/`.
   Plotly Express functions
   are designed to be highly consistent with each other, and to do *as little computation
   in Python as possible*, generally concerning themselves with formatting data and creating
@@ -49,13 +49,13 @@ There are many ways to contribute to plotly.py. To contribute effectively, it is
   as we are introducing more features into `plotly.express`. Some issues in the
   tracker are labeled "figure_factory" and can be good issues to work on. More
   instructions on figure factories are found
-  [here](packages/python/plotly/plotly/figure_factory/README.md).
+  [here](plotly/figure_factory/README.md).
 
 - other pure-Python submodules are: `plotly.io` (low-level interface for
   displaying, reading and writing figures), `plotly.subplots` (helper function
   for layout of multi-plot figures)
 
-- tests are found in `packages/python/plotly/plotly/tests`. Different
+- tests are found in `plotly/tests`. Different
   directories correspond to different test jobs (with different dependency sets)
   run in continuous integration. More is explained about tests
   in the following "Technical aspects" section.
@@ -138,27 +138,25 @@ We will support Python 3.12 and higher versions soon.
 
 ### Install development requirements (Non-Windows)
 ```bash
-(plotly_dev) $ pip install -r packages/python/plotly/requires-optional.txt
+(plotly_dev) $ pip install -r requires-optional.txt
  ```
 ### Install development requirements (Windows + Conda)
 Because Windows requires Visual Studio libraries to compile some of the optional dependencies, follow these steps to
 complete installation and avoid gdal-config errors.
 
 ```bash
 (plotly_dev) $ conda install fiona
-(plotly_dev) $ pip install -r packages/python/plotly/requires-optional.txt
+(plotly_dev) $ pip install -r requires-optional.txt
 ```
 
 ### Editable install of plotly packages
 ```bash
-(plotly_dev) $ pip install -e packages/python/plotly/
-(plotly_dev) $ pip install -e packages/python/chart-studio/
-(plotly_dev) $ pip install -e packages/python/plotly-geo/
+(plotly_dev) $ pip install -e .
 ```
 
 **Note**: To test `go.FigureWidget` locally, you'll need to generate the javascript bundle as follows:
 ```
-cd packages/python/plotly/js
+cd js
 npm install && npm run build
 ```
 
@@ -176,7 +174,7 @@ documentation on _development mode_.
 This repo uses the [Black](https://black.readthedocs.io/en/stable/) code formatter,
 and the [pre-commit](https://pre-commit.com/) library to manage a git commit hook to
 run Black prior to each commit.  Both pre-commit and black are included in the
-`packages/python/plotly/requires-optional.txt` file, so you should have them
+`requires-optional.txt` file, so you should have them
 installed already if you've been following along.
 
 To enable the Black formatting git hook, run the following from within your virtual
@@ -200,7 +198,7 @@ a PR as follows.
 
 ### Making a Development Branch
 
-Third, *don't* work in the `master` branch. As soon as you get your master branch ready, run:
+Third, *don't* work in the `main` branch. As soon as you get your main branch ready, run:
 
 **DO THIS (but change the branch name)**
 ```bash
@@ -216,13 +214,12 @@ make that pull request!
 
 
 ## Update to a new version of Plotly.js
-First update the version of the `plotly.js` dependency in `packages/python/plotly/js/package.json`.
+First update the version of the `plotly.js` dependency in `js/package.json`.
 
 Then run the `updateplotlyjs` command with:
 
 ```bash
-$ cd packages/python/plotly
-$ python setup.py updateplotlyjs
+$ python commands.py updateplotlyjs
 ```
 
 This will download new versions of `plot-schema.json` and `plotly.min.js` from
@@ -236,7 +233,7 @@ For dev branches, it is also possible to use `updateplotlyjsdev` in two configur
 
 If your devbranch is part of the official plotly.js repository, you can use
 ```bash
-python setup.py updateplotlyjsdev --devrepo reponame --devbranch branchname
+python commands.py updateplotlyjsdev --devrepo reponame --devbranch branchname
 ```
 to update to development versions of `plotly.js`. This will fetch the `plotly.js` in the CircleCI artifact of the branch `branchname` of the repo `reponame`. If `--devrepo` or `--devbranch` are omitted, `updateplotlyjsdev` defaults using `plotly/plotly.js` and `master` respectively.
 
@@ -251,16 +248,13 @@ $ npm run build
 $ npm pack
 $ mv plotly.js-*.tgz plotly.js.tgz
 
-# In your plotly.py/packages/python/plotly/ directory:
-$ python setup.py updateplotlyjsdev --local /path/to/your/plotly.js/
+# In your plotly.py/ directory:
+$ python commands.py updateplotlyjsdev --local /path/to/your/plotly.js/
 ```
 
 ## Testing
 
-We take advantage of two tools to run tests:
-
-* [`tox`](https://tox.readthedocs.io/en/latest/), which is both a virtualenv management and test tool.
-* [`pytest`](https://docs.pytest.org/en/latest/), a powerful framework for unit testing.
+To run tests, we use [`pytest`](https://docs.pytest.org/en/latest/), a powerful framework for unit testing.
 
 ### Running Tests with `pytest`
 
@@ -269,79 +263,35 @@ Since our tests cover *all* the functionality, to prevent tons of errors from sh
 After you've done that, go ahead and run the test suite!
 
 ```bash
-pytest  packages/python/plotly/plotly/tests/
+pytest tests/
 ```
 
 Or for more *verbose* output:
 
 ```bash
-pytest -v  packages/python/plotly/plotly/tests/
+pytest -v tests/
 ```
 
 Either of those will run *every* test we've written for the Python API. You can get more granular by running something like:
 
 ```bash
-pytest  packages/python/plotly/plotly/tests/test_core/
+pytest tests/test_core/
 ```
 
 ... or even more granular by running something like:
 
 ```bash
-pytest plotly/tests/test_plotly/test_plot.py
+pytest tests/test_plotly/test_plot.py
 ```
 
 or for a specific test function
 
 ```bash
-pytest plotly/tests/test_plotly/test_plot.py::test_function
-```
-
-### Running tests with `tox`
-
-Running tests with tox is much more powerful, but requires a bit more setup.
-
-You'll need to export an environment variable for *each* tox environment you wish to test with. For example, if you want to test with `Python 3.9` and
-`Python 3.6`, but only care to check the `core` specs, you would need to ensure that the following variables are exported:
-
-```
-export PLOTLY_TOX_PYTHON_39=<python binary>
-export PLOTLY_TOX_PYTHON_36=<python binary>
-```
-
-Where the `<python binary` is going to be specific to your development setup. As a more complete example, you might have this loaded in a `.bash_profile` (or equivalent shell loader):
-
-```bash
-############
-# tox envs #
-############
-
-export PLOTLY_TOX_PYTHON_39=python3.9
-export PLOTLY_TOX_PYTHON_36=python3.6
-export TOXENV=py39-core,py36-core
-```
-
-Where `TOXENV` is the environment list you want to use when invoking `tox` from the command line. Note that the `PLOTLY_TOX_*` pattern is used to pass in variables for use in the `tox.ini` file. Though this is a little setup, intensive, you'll get the following benefits:
-
-* `tox` will automatically manage a virtual env for each environment you want to test in.
-* You only have to run `tox` and know that the module is working in all included Python versions.
-
-Finally, `tox` allows you to pass in additional command line arguments that are formatted in (by us) in the `tox.ini` file, see `{posargs}`. This is setup to help with our configuration of [pytest markers](http://doc.pytest.org/en/latest/example/markers.html), which are set up in `packages/python/plotly/pytest.ini`. To run only tests that are *not* tagged with `nodev`, you could use the following command:
-
-```bash
-tox -- -a '!nodev'
-```
-
-Note that anything after `--` is substituted in for `{posargs}` in the tox.ini. For completeness, because it's reasonably confusing, if you want to force a match for *multiple* `pytest` marker tags, you comma-separate the tags like so:
-
-```bash
-tox -- -a '!nodev','!matplotlib'
+pytest tests/test_plotly/test_plot.py::test_function
 ```
 
 ### Writing Tests
 
 You're *strongly* encouraged to write tests that check your added functionality.
 
 When you write a new test anywhere under the `tests` directory, if your PR gets accepted, that test will run in a virtual machine to ensure that future changes don't break your contributions!
-
-Test accounts include: `PythonTest`, `PlotlyImageTest`, and  `PlotlyStageTest`.
-

.gitignore

@@ -1,7 +1,5 @@
 include LICENSE.txt
 include README.md
-include versioneer.py
-include plotly/_version.py
 include requires-install.txt
 include requires-express.txt
 include plotly/package_data/widgetbundle.js

.pre-commit-config.yaml

@@ -1,3 +1,6 @@
+# Migration to Version 6
+See https://plotly.com/python/v6-migration/
+
 # Migration to Version 5
 See https://community.plotly.com/t/introducing-plotly-py-5-0-0-a-new-federated-jupyter-extension-icicle-charts-and-bar-chart-patterns/54039
 

CHANGELOG.md

@@ -67,7 +67,7 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
 ---
 
 - [Online Documentation](https://plotly.com/python/)
-- [Contributing to plotly](https://github.com/plotly/plotly.py/blob/master/contributing.md)
+- [Contributing to plotly](https://github.com/plotly/plotly.py/blob/master/CONTRIBUTING.md)
 - [Changelog](https://github.com/plotly/plotly.py/blob/master/CHANGELOG.md)
 - [Code of Conduct](https://github.com/plotly/plotly.py/blob/master/CODE_OF_CONDUCT.md)
 - [Community forum](https://community.plotly.com)
@@ -141,6 +141,8 @@ or conda
 conda install -c plotly plotly-geo=1.0.0
 ```
 
+`plotly-geo` can be found on Github at https://github.com/plotly/plotly-geo.
+
 ## Copyright and Licenses
 
 Code and documentation copyright 2019 Plotly, Inc.