hvplot 0.13.0a2__tar.gz → 0.13.0rc1__tar.gz

{hvplot-0.13.0a2 → hvplot-0.13.0rc1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: hvplot
-Version: 0.13.0a2
+Version: 0.13.0rc1
 Summary: A high-level plotting API for the PyData ecosystem built on HoloViews.
 Project-URL: Homepage, https://hvplot.holoviz.org
 Project-URL: Source, http://github.com/holoviz/hvplot
@@ -15,14 +15,14 @@ Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Requires-Dist: bokeh>=3.1
 Requires-Dist: colorcet>=2
 Requires-Dist: holoviews>=1.19.0
@@ -35,6 +35,7 @@ Provides-Extra: dev-extras
 Requires-Dist: setuptools-scm>=6; extra == 'dev-extras'
 Provides-Extra: doc
 Requires-Dist: bokeh-sampledata>=2025.0; extra == 'doc'
+Requires-Dist: bokeh>=3.10; extra == 'doc'
 Requires-Dist: dask[dataframe]>=2021.3.0; extra == 'doc'
 Requires-Dist: datashader>=0.6.5; extra == 'doc'
 Requires-Dist: duckdb; extra == 'doc'
@@ -53,6 +54,7 @@ Requires-Dist: notebook>=5.4; extra == 'doc'
 Requires-Dist: numba>=0.51.0; extra == 'doc'
 Requires-Dist: numpydoc; extra == 'doc'
 Requires-Dist: pillow>=8.2.0; extra == 'doc'
+Requires-Dist: playwright; extra == 'doc'
 Requires-Dist: plotly; extra == 'doc'
 Requires-Dist: polars; extra == 'doc'
 Requires-Dist: pooch>=1.6.0; extra == 'doc'
@@ -60,11 +62,11 @@ Requires-Dist: s3fs>=2022.1.0; extra == 'doc'
 Requires-Dist: scikit-image>=0.17.2; extra == 'doc'
 Requires-Dist: scikit-learn>=1.4.0; extra == 'doc'
 Requires-Dist: scipy>=1.5.3; extra == 'doc'
-Requires-Dist: selenium>=3.141.0; extra == 'doc'
 Requires-Dist: sphinxcontrib-mermaid; extra == 'doc'
 Requires-Dist: sphinxext-rediraffe; extra == 'doc'
 Requires-Dist: sqlglot; extra == 'doc'
 Requires-Dist: xarray>=0.18.2; extra == 'doc'
+Requires-Dist: xugrid>=0.15.0; extra == 'doc'
 Requires-Dist: xyzservices>=2022.9.0; extra == 'doc'
 Provides-Extra: examples
 Requires-Dist: bokeh-sampledata>=2025.0; extra == 'examples'
@@ -84,6 +86,7 @@ Requires-Dist: networkx>=2.6.3; extra == 'examples'
 Requires-Dist: notebook>=5.4; extra == 'examples'
 Requires-Dist: numba>=0.51.0; extra == 'examples'
 Requires-Dist: pillow>=8.2.0; extra == 'examples'
+Requires-Dist: playwright; extra == 'examples'
 Requires-Dist: plotly; extra == 'examples'
 Requires-Dist: polars; extra == 'examples'
 Requires-Dist: pooch>=1.6.0; extra == 'examples'
@@ -91,9 +94,9 @@ Requires-Dist: s3fs>=2022.1.0; extra == 'examples'
 Requires-Dist: scikit-image>=0.17.2; extra == 'examples'
 Requires-Dist: scikit-learn>=1.4.0; extra == 'examples'
 Requires-Dist: scipy>=1.5.3; extra == 'examples'
-Requires-Dist: selenium>=3.141.0; extra == 'examples'
 Requires-Dist: sqlglot; extra == 'examples'
 Requires-Dist: xarray>=0.18.2; extra == 'examples'
+Requires-Dist: xugrid>=0.15.0; extra == 'examples'
 Requires-Dist: xyzservices>=2022.9.0; extra == 'examples'
 Provides-Extra: examples-tests
 Requires-Dist: bokeh-sampledata>=2025.0; extra == 'examples-tests'
@@ -114,6 +117,7 @@ Requires-Dist: networkx>=2.6.3; extra == 'examples-tests'
 Requires-Dist: notebook>=5.4; extra == 'examples-tests'
 Requires-Dist: numba>=0.51.0; extra == 'examples-tests'
 Requires-Dist: pillow>=8.2.0; extra == 'examples-tests'
+Requires-Dist: playwright; extra == 'examples-tests'
 Requires-Dist: plotly; extra == 'examples-tests'
 Requires-Dist: polars; extra == 'examples-tests'
 Requires-Dist: pooch>=1.6.0; extra == 'examples-tests'
@@ -122,9 +126,9 @@ Requires-Dist: s3fs>=2022.1.0; extra == 'examples-tests'
 Requires-Dist: scikit-image>=0.17.2; extra == 'examples-tests'
 Requires-Dist: scikit-learn>=1.4.0; extra == 'examples-tests'
 Requires-Dist: scipy>=1.5.3; extra == 'examples-tests'
-Requires-Dist: selenium>=3.141.0; extra == 'examples-tests'
 Requires-Dist: sqlglot; extra == 'examples-tests'
 Requires-Dist: xarray>=0.18.2; extra == 'examples-tests'
+Requires-Dist: xugrid>=0.15.0; extra == 'examples-tests'
 Requires-Dist: xyzservices>=2022.9.0; extra == 'examples-tests'
 Provides-Extra: fugue-sql
 Requires-Dist: fugue-sql-antlr>=0.2.4; extra == 'fugue-sql'
@@ -163,7 +167,6 @@ Requires-Dist: ipywidgets; extra == 'tests'
 Requires-Dist: jinja2; extra == 'tests'
 Requires-Dist: matplotlib; extra == 'tests'
 Requires-Dist: numpydoc; extra == 'tests'
-Requires-Dist: parameterized; extra == 'tests'
 Requires-Dist: plotly; extra == 'tests'
 Requires-Dist: polars; extra == 'tests'
 Requires-Dist: pooch; extra == 'tests'
@@ -171,6 +174,9 @@ Requires-Dist: pre-commit; extra == 'tests'
 Requires-Dist: psutil; extra == 'tests'
 Requires-Dist: pytest; extra == 'tests'
 Requires-Dist: pytest-cov; extra == 'tests'
+Requires-Dist: pytest-randomly; extra == 'tests'
+Requires-Dist: pytest-socket; extra == 'tests'
+Requires-Dist: pytest-xdist; extra == 'tests'
 Requires-Dist: ruff; extra == 'tests'
 Requires-Dist: scipy; extra == 'tests'
 Requires-Dist: spatialpandas; extra == 'tests'
@@ -183,13 +189,15 @@ Requires-Dist: dask[dataframe]; extra == 'tests-core'
 Requires-Dist: ipywidgets; extra == 'tests-core'
 Requires-Dist: matplotlib; extra == 'tests-core'
 Requires-Dist: numpydoc; extra == 'tests-core'
-Requires-Dist: parameterized; extra == 'tests-core'
 Requires-Dist: plotly; extra == 'tests-core'
 Requires-Dist: pooch; extra == 'tests-core'
 Requires-Dist: pre-commit; extra == 'tests-core'
 Requires-Dist: psutil; extra == 'tests-core'
 Requires-Dist: pytest; extra == 'tests-core'
 Requires-Dist: pytest-cov; extra == 'tests-core'
+Requires-Dist: pytest-randomly; extra == 'tests-core'
+Requires-Dist: pytest-socket; extra == 'tests-core'
+Requires-Dist: pytest-xdist; extra == 'tests-core'
 Requires-Dist: ruff; extra == 'tests-core'
 Requires-Dist: scipy; extra == 'tests-core'
 Requires-Dist: xarray; extra == 'tests-core'

{hvplot-0.13.0a2 → hvplot-0.13.0rc1}/doc/_ext/plotting_options_table.py

@@ -14,6 +14,14 @@ from sphinx.util.docutils import SphinxDirective
 
 from hvplot.util import _get_docstring_group_parameters
 
+# Deprecated options that have no definition section to link to
+OPTIONS_WITHOUT_DEFINITION = {'hover_formatters'}
+
+
+def option_label(name):
+    """Label of an option definition, e.g. 'xlim/ylim' -> 'option-xlim__ylim'."""
+    return 'option-' + name.replace('/', '__')
+
 
 class PlottingOptionsTableDirective(SphinxDirective):
     """
@@ -29,16 +37,27 @@ class PlottingOptionsTableDirective(SphinxDirective):
         # Get the key passed to the directive
         options_group = self.arguments[0]
         parameters = _get_docstring_group_parameters(options_group)
-        table_rst = ['.. list-table::', '   :header-rows: 1', '   :widths: 25 70', '']
+        table_rst = [
+            '.. list-table::',
+            '   :header-rows: 1',
+            '   :widths: 25 70',
+            '   :class: plotting-options-table',
+            '',
+        ]
         table_rst.append('   * - ')
         table_rst.append('       Parameters')
         table_rst.append('     - ')
         table_rst.append('       Description')
 
         for param in parameters:
+            if param.name in OPTIONS_WITHOUT_DEFINITION:
+                name = f'**{param.name}**'
+            else:
+                # A role cannot be nested in **bold**, custom.css makes the link bold
+                name = f':ref:`{param.name} <{option_label(param.name)}>`'
             desc = '\n'.join(param.desc)
             table_rst.append('   * - ')
-            table_rst.append(f'       **{param.name}** *({param.type})*')
+            table_rst.append(f'       {name} *({param.type})*')
             table_rst.append('     - ')
             table_rst.append(indent(desc, ' ' * 7))
 

{hvplot-0.13.0a2 → hvplot-0.13.0rc1}/doc/_static/custom.css

@@ -26,3 +26,8 @@
     padding: 0.7em 3em !important;
     font-size: 1.2em;
 }
+
+/* Option names are links in the plotting options tables */
+.plotting-options-table td:first-child a {
+  font-weight: bold;
+}

{hvplot-0.13.0a2 → hvplot-0.13.0rc1}/doc/conf.py

@@ -50,6 +50,8 @@ html_theme_options.update(  # noqa: F405
     {
         'navbar_start': ['navbar-logo', 'version-switcher'],
         'use_edit_page_button': True,
+        # Tutorials, User Guide, How-To, Gallery, Reference and Explanation inline
+        'header_links_before_dropdown': 7,
         'github_url': 'https://github.com/holoviz/hvplot',
         'icon_links': [
             {
@@ -69,7 +71,6 @@ html_theme_options.update(  # noqa: F405
             },
         ],
         'pygments_dark_style': 'material',
-        'announcement': "hvPlot 0.12 has just been released! Checkout the <a href='https://blog.holoviz.org/posts/hvplot_release_0.12/'>blog post</a> and support hvPlot by giving it a 🌟 on <a href='https://github.com/holoviz/hvplot'>Github</a>.",  # noqa: E501
         'switcher': {
             'json_url': 'https://hvplot.holoviz.org/switcher.json',
             'version_match': switcher_version,
@@ -108,6 +109,40 @@ myst_enable_extensions = [
     'html_image',
 ]
 
+API_PLOT_METHODS = [
+    'hvPlot.area',
+    'hvPlot.bar',
+    'hvPlot.barh',
+    'hvPlot.bivariate',
+    'hvPlot.box',
+    'hvPlot.contour',
+    'hvPlot.contourf',
+    'hvPlot.density',
+    'hvPlot.errorbars',
+    'hvPlot.heatmap',
+    'hvPlot.hexbin',
+    'hvPlot.hist',
+    'hvPlot.image',
+    'hvPlot.kde',
+    'hvPlot.labels',
+    'hvPlot.line',
+    'hvPlot.ohlc',
+    'hvPlot.paths',
+    'hvPlot.points',
+    'hvPlot.polygons',
+    'hvPlot.quadmesh',
+    'hvPlot.rgb',
+    'hvPlot.scatter',
+    'hvPlot.step',
+    'hvPlot.table',
+    'hvPlot.vectorfield',
+    'hvPlot.violin',
+    'plotting.andrews_curves',
+    'plotting.lag_plot',
+    'plotting.parallel_coordinates',
+    'plotting.scatter_matrix',
+]
+
 nbsite_gallery_conf = {
     'github_org': 'holoviz',
     'github_project': 'hvplot',
@@ -123,6 +158,21 @@ nbsite_gallery_conf = {
                 '`HoloViz Examples website <https://examples.holoviz.org>`_.'
             ),
             'sections': [
+                {
+                    'path': 'api',
+                    'title': 'API Reference',
+                    'description': (
+                        'One example per plotting method, linking to its API reference page.'
+                    ),
+                    'items': [
+                        {
+                            'title': method.split('.')[-1],
+                            # Relative URL so the link stays in the same docs version.
+                            'url': f'../ref/api/manual/hvplot.{method}.html',
+                        }
+                        for method in API_PLOT_METHODS
+                    ],
+                },
                 {
                     'path': 'basic-charts',
                     'title': 'Basic Charts',
@@ -173,6 +223,13 @@ rediraffe_redirects = {
     'user_guide/Customization': 'ref/plotting_options/index',
     # Pandas API viz user guide moved to the reference
     'user_guide/pandas_api': 'ref/api_compatibility/pandas/Pandas_API',
+    # User guides replaced by tutorials, how-to and explanation guides
+    'user_guide/Introduction': 'tutorials/getting_started',
+    'user_guide/Explorer': 'tutorials/explorer',
+    'user_guide/Plotting_Extensions': 'how_to/load_switch_plotting_extensions',
+    'user_guide/Viewing': 'how_to/display_plots',
+    'user_guide/Subplots': 'how_to/split_into_subplots',
+    'user_guide/Statistical_Plots': 'explanation/statistical_plot_types',
 }
 
 html_extra_path = ['topics.html']

{hvplot-0.13.0a2 → hvplot-0.13.0rc1}/doc/conftest.py

@@ -2,7 +2,6 @@ import os
 from importlib.util import find_spec
 
 import dask
-from bokeh.io.webdriver import webdriver_control
 from packaging.version import Version, parse
 
 from hvplot.util import _PD_GE_3_0_0
@@ -35,7 +34,6 @@ if not find_spec('geoviews'):  # geo examples
         'ref/api/manual/hvplot.hvPlot.vectorfield.ipynb',
         'ref/data_libraries.ipynb',
         'ref/plotting_options/geographic.ipynb',
-        'user_guide/Explorer.ipynb',
         'user_guide/Geographic_Data.ipynb',
         'user_guide/Integrations.ipynb',
     ]
@@ -65,17 +63,12 @@ try:
 except ImportError:
     pass
 
-if find_spec('selenium'):
-    try:
-        webdriver_control.create()
-    except RuntimeError:
-        # hvplot.save() with bokeh
-        collect_ignore_glob += [
-            'user_guide/Viewing.ipynb',
-            'user_guide/NetworkX.ipynb',
-        ]
-    finally:
-        webdriver_control.cleanup()
+# Bokeh PNG export (hvplot.save) needs Playwright and a browser, which are only
+# installed when building the docs, not when running the examples tests.
+collect_ignore_glob += [
+    'how_to/save_bokeh_plots.ipynb',
+    'user_guide/NetworkX.ipynb',
+]
 
 pygraphviz = None
 

{hvplot-0.13.0a2 → hvplot-0.13.0rc1}/doc/developer_guide.md

@@ -171,10 +171,14 @@ Unit tests can be run with the `test-unit` task:
 pixi run test-unit
 ```
 
+The tests run in parallel and in a random order. Slow tests are skipped unless you pass `--slow`, e.g. `pixi run test-unit --slow`.
+
+Every plot returned by hvPlot during the tests is also rendered with the current plotting backend, as a configuration that HoloViews accepts can still fail when the plot is built. Pass `--no-render` for a faster run, e.g. `pixi run test-unit --no-render`.
+
 :::{admonition} Advanced usage
 :class: tip
 
-The task is available in the following environments: `test-310`, `test-311`, `test-312`, `test-313`, and `test-core`. Where the first ones have the same environments except for different Python versions, and `test-core` only has a core set of dependencies.
+The task is available in the following environments: `test-311`, `test-312`, `test-313`, `test-314`, and `test-core`. Where the first ones have the same environments except for different Python versions, and `test-core` (Python 3.15) only has a core set of dependencies.
 
 You can run the task in a specific environment with the `-e` flag. For example, to run the `test-unit` task in the `test-313` environment, you can run:
 
@@ -195,6 +199,65 @@ pixi run -e test-core install
 
 :::
 
+#### Writing unit tests
+
+Tests are plain pytest functions. Where a test goes:
+
+| I'm testing... | Add the test to |
+|---|---|
+| a plot option, e.g. `xlabel` | `hvplot/tests/options/test_<group>.py`, the group being the option's section in the docs, e.g. `test_axis.py` |
+| a kind or one of its options, e.g. `bins` of `hist` | `hvplot/tests/kinds/test_<kind>.py` |
+| something only one data library does | the kind or option module, with the library in the test name, e.g. `test_hover_cols_all_geodataframe` |
+| anything else | the module mirroring the source file, e.g. `test_util.py` for `hvplot/util.py` |
+
+Name option tests `test_<option>` or `test_<option>_<detail>`: `test_options_inventory.py` and `test_kinds_inventory.py` fail when an option or a kind has no test, and tell you which test to add where. A new kind also runs in `kinds/test_all_kinds.py` with every data library and backend, its known failures go in the dicts at the top of that module.
+
+A test of a backend-specific option, with a known failure on one backend:
+
+```python
+@pytest.mark.parametrize(
+    'backend',
+    [
+        'bokeh',
+        'matplotlib',
+        pytest.param(
+            'plotly',
+            marks=pytest.mark.xfail(
+                reason='HoloViews: plotly has no legend_position option',
+                raises=KeyError,
+                strict=False,
+            ),
+        ),
+    ],
+    indirect=True,
+)
+def test_legend_position(hvplot_pandas, backend):
+    df = pd.DataFrame({'x': [1, 2], 'y': [3, 4], 'category': ['a', 'b']})
+    plot = df.hvplot.scatter('x', 'y', by='category', legend='left')
+    assert Store.lookup_options(backend, plot, 'plot').kwargs['legend_position'] == 'left'
+```
+
+The fixtures are in `hvplot/tests/conftest.py`:
+
+- `hvplot_pandas` and `hvplot_xarray` add the `.hvplot` accessor. Don't `import hvplot.pandas` at the top of a test module, this is reported as an error.
+- `backend` runs the test with Bokeh, Matplotlib and Plotly. Request it after the accessor fixtures.
+- `tabular_lib` and `gridded_lib` run the test with each data library, converting pandas or Xarray data: `tabular_lib(df).hvplot.scatter(...)`.
+- `block_import('geoviews')` makes a module look not installed.
+
+The global state (HoloViews options, plotting backend, accessors) is restored after each test.
+
+Data: write option and kind tests with pandas. Use `tabular_lib` or `gridded_lib` when asserting something that depends on the data library, and `@pandas_and_dask` from `hvplot/tests/_deps.py` when the test needs an index or the pandas API (Dask has its own code paths). If the option reads the data (a column name, a template, `hv.dim`, `'time.hour'`, a Datashader reduction...), also add a case to `CASES` in `data_libraries/test_tabular_parity.py`, which compares every tabular library with pandas. Tests can't access the internet, use `hvplot/tests/_data.py` or build the data in the test.
+
+Marks:
+
+- `@pytest.mark.slow` for tests taking more than about a second and all the tests running Datashader.
+- `@pytest.mark.geo` for tests using GeoViews, `@requires('datashader')` from `_deps.py` for other optional dependencies.
+- `@pytest.mark.xfail(reason='BUG: <description>')` for an hvPlot bug not fixed yet. It is strict, the test fails once the bug is fixed. When another library is at fault, name it in the reason (`'HoloViews: ...'`) and pass `strict=False`, as above.
+- `render_xfail` is the same for a test that only fails when its plot is rendered.
+- `lib_xfail('ibis', reason=...)` and `lib_render_xfail(...)` are the same for the test run with these libraries only. `lib_skip('duckdb', reason=...)` skips a library the test doesn't apply to.
+
+To add a data library, follow the comment above `TABULAR_LIBS` in `hvplot/tests/_deps.py`.
+
 ### Example tests
 
 hvPlot's documentation consists mainly of Jupyter Notebooks. The example tests execute all the notebooks and fail if an error is raised. Example tests are possible thanks to [nbval](https://nbval.readthedocs.io/) and can be found in the `doc/` folder.
@@ -223,6 +286,17 @@ As hvPlot uses notebooks for much of the documentation, this takes a little whil
 
 A development version of hvPlot can be found [here](https://holoviz-dev.github.io/hvplot/). You can ask a maintainer if they want to make a dev release for your PR, but there is no guarantee they will say yes.
 
+### Markdown docs and `llms.txt`
+
+As part of `docs-build`, hvPlot also generates clean Markdown versions of its documentation together with an `llms.txt` index file that points AI assistants at the most relevant pages.
+
+The build produces:
+
+- `builtdocs/markdown/` - a Markdown rendering of the documentation
+- `builtdocs/llms.txt` - an index of the most useful documentation pages for LLM-assisted development
+
+See [How to Use hvPlot with an AI Assistant](how_to/use_ai_assistant.md) for how to consume these docs with an AI assistant.
+
 ### Link to hvPlot objects
 
 ```md