xarray-plotly 0.0.2__tar.gz → 0.0.4__tar.gz

xarray_plotly-0.0.4/.github/dependabot.yml

@@ -0,0 +1,25 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      dev-dependencies:
+        patterns:
+          - "pytest*"
+          - "mypy"
+          - "ruff"
+          - "pre-commit"
+          - "nbstripout"
+      docs-dependencies:
+        patterns:
+          - "mkdocs*"
+          - "pooch"
+          - "netcdf4"
+          - "jupyter"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

{xarray_plotly-0.0.2 → xarray_plotly-0.0.4}/.github/workflows/ci.yml

@@ -14,10 +14,10 @@ jobs:
         python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v7
 
       - name: Set up Python ${{ matrix.python-version }}
         run: uv python install ${{ matrix.python-version }}
@@ -35,7 +35,7 @@ jobs:
         run: uv run pytest --cov=xarray_plotly --cov-report=xml
 
       - name: Upload coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         if: matrix.python-version == '3.12'
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

xarray_plotly-0.0.4/.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,24 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: github.actor == 'dependabot[bot]'
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v2
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+      - name: Auto-merge minor and patch updates
+        if: steps.metadata.outputs.update-type == 'version-update:semver-patch' || steps.metadata.outputs.update-type == 'version-update:semver-minor'
+        run: gh pr merge --auto --squash "$PR_URL"
+        env:
+          PR_URL: ${{ github.event.pull_request.html_url }}
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{xarray_plotly-0.0.2 → xarray_plotly-0.0.4}/.github/workflows/docs.yml

@@ -14,10 +14,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v7
 
       - name: Install dependencies
         run: uv sync --extra docs

{xarray_plotly-0.0.2 → xarray_plotly-0.0.4}/.github/workflows/release.yml

@@ -13,10 +13,10 @@ jobs:
       contents: write  # for creating GitHub release
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v7
 
       - name: Build package
         run: uv build

{xarray_plotly-0.0.2 → xarray_plotly-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xarray_plotly
-Version: 0.0.2
+Version: 0.0.4
 Summary: Interactive Plotly Express plotting accessor for xarray
 Author: Felix
 License: MIT
@@ -25,18 +25,19 @@ Requires-Dist: xarray>=2023.1.0
 Requires-Dist: plotly>=5.0.0
 Requires-Dist: pandas>=1.5.0
 Provides-Extra: dev
-Requires-Dist: pytest>=7.0; extra == "dev"
-Requires-Dist: pytest-cov>=4.0; extra == "dev"
-Requires-Dist: mypy>=1.0; extra == "dev"
-Requires-Dist: ruff>=0.4; extra == "dev"
-Requires-Dist: pre-commit>=3.0; extra == "dev"
-Requires-Dist: nbstripout>=0.6; extra == "dev"
+Requires-Dist: pytest==9.0.2; extra == "dev"
+Requires-Dist: pytest-cov==7.0.0; extra == "dev"
+Requires-Dist: mypy==1.19.1; extra == "dev"
+Requires-Dist: ruff==0.14.11; extra == "dev"
+Requires-Dist: pre-commit==4.5.1; extra == "dev"
+Requires-Dist: nbstripout==0.8.2; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: mkdocs>=1.5; extra == "docs"
-Requires-Dist: mkdocs-material>=9.0; extra == "docs"
-Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
-Requires-Dist: mkdocs-jupyter>=0.24; extra == "docs"
-Requires-Dist: mkdocs-plotly-plugin>=0.1; extra == "docs"
+Requires-Dist: mkdocs==1.6.1; extra == "docs"
+Requires-Dist: mkdocs-material==9.7.1; extra == "docs"
+Requires-Dist: mkdocstrings[python]==1.0.0; extra == "docs"
+Requires-Dist: mkdocs-jupyter==0.25.1; extra == "docs"
+Requires-Dist: mkdocs-plotly-plugin==0.1.3; extra == "docs"
+Requires-Dist: jupyter==1.1.1; extra == "docs"
 Dynamic: license-file
 
 # xarray_plotly
@@ -45,7 +46,9 @@ Dynamic: license-file
 
 [![PyPI version](https://badge.fury.io/py/xarray_plotly.svg)](https://badge.fury.io/py/xarray_plotly)
 [![Python](https://img.shields.io/pypi/pyversions/xarray_plotly.svg)](https://pypi.org/project/xarray_plotly/)
+[![CI](https://github.com/FBumann/xarray_plotly/actions/workflows/ci.yml/badge.svg)](https://github.com/FBumann/xarray_plotly/actions)
 [![Docs](https://img.shields.io/badge/docs-fbumann.github.io-blue)](https://fbumann.github.io/xarray_plotly/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Installation
 
@@ -75,6 +78,8 @@ from xarray_plotly import xpx
 fig = xpx(da).line()
 ```
 
+**Why `xpx()`?** The accessor (`da.plotly`) works but IDEs can't provide code completion for it. This is because xarray accessors are registered dynamically at runtime, making them invisible to static type checkers. The `xpx()` function provides the same functionality with full IDE support. This limitation could only be solved by xarray itself, if at all — it may be a fundamental Python limitation.
+
 ## Documentation
 
 Full documentation: [https://fbumann.github.io/xarray_plotly](https://fbumann.github.io/xarray_plotly)

{xarray_plotly-0.0.2 → xarray_plotly-0.0.4}/README.md

@@ -4,7 +4,9 @@
 
 [![PyPI version](https://badge.fury.io/py/xarray_plotly.svg)](https://badge.fury.io/py/xarray_plotly)
 [![Python](https://img.shields.io/pypi/pyversions/xarray_plotly.svg)](https://pypi.org/project/xarray_plotly/)
+[![CI](https://github.com/FBumann/xarray_plotly/actions/workflows/ci.yml/badge.svg)](https://github.com/FBumann/xarray_plotly/actions)
 [![Docs](https://img.shields.io/badge/docs-fbumann.github.io-blue)](https://fbumann.github.io/xarray_plotly/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## Installation
 
@@ -34,6 +36,8 @@ from xarray_plotly import xpx
 fig = xpx(da).line()
 ```
 
+**Why `xpx()`?** The accessor (`da.plotly`) works but IDEs can't provide code completion for it. This is because xarray accessors are registered dynamically at runtime, making them invisible to static type checkers. The `xpx()` function provides the same functionality with full IDE support. This limitation could only be solved by xarray itself, if at all — it may be a fundamental Python limitation.
+
 ## Documentation
 
 Full documentation: [https://fbumann.github.io/xarray_plotly](https://fbumann.github.io/xarray_plotly)

xarray_plotly-0.0.4/docs/examples/dimensions.ipynb

@@ -0,0 +1,232 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Dimensions, Facets & Animation\n",
+    "\n",
+    "How to control which dimensions map to which visual properties."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import plotly.express as px\n",
+    "import xarray as xr\n",
+    "\n",
+    "from xarray_plotly import config, xpx\n",
+    "\n",
+    "config.notebook()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Sample data: 2D\n",
+    "df = px.data.stocks().set_index(\"date\")\n",
+    "df.index = df.index.astype(\"datetime64[ns]\")\n",
+    "\n",
+    "stocks = xr.DataArray(\n",
+    "    df.values,\n",
+    "    dims=[\"date\", \"company\"],\n",
+    "    coords={\"date\": df.index, \"company\": df.columns.tolist()},\n",
+    "    name=\"price\",\n",
+    ")\n",
+    "\n",
+    "# Sample data: 3D\n",
+    "df_gap = px.data.gapminder()\n",
+    "countries = [\"United States\", \"China\", \"Germany\", \"Brazil\"]\n",
+    "metrics = [\"lifeExp\", \"gdpPercap\"]\n",
+    "\n",
+    "arrays = []\n",
+    "for metric in metrics:\n",
+    "    df_pivot = df_gap[df_gap[\"country\"].isin(countries)].pivot(\n",
+    "        index=\"year\", columns=\"country\", values=metric\n",
+    "    )\n",
+    "    arrays.append(df_pivot.values)\n",
+    "\n",
+    "data_3d = xr.DataArray(\n",
+    "    arrays,\n",
+    "    dims=[\"metric\", \"year\", \"country\"],\n",
+    "    coords={\n",
+    "        \"metric\": metrics,\n",
+    "        \"year\": df_pivot.index.tolist(),\n",
+    "        \"country\": df_pivot.columns.tolist(),\n",
+    "    },\n",
+    "    name=\"value\",\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Default Dimension Assignment\n",
+    "\n",
+    "Dimensions are assigned to slots in order:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# date → x, company → color\n",
+    "xpx(stocks).line()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Explicit Assignment\n",
+    "\n",
+    "Override the defaults by specifying which dimension goes where:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Swap: company → x, date → color\n",
+    "xpx(stocks.isel(date=[0, 50, 100])).bar(x=\"company\", color=\"date\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Skipping Slots with None\n",
+    "\n",
+    "Use `None` to skip a slot, so dimensions shift to the next available slot:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Skip color → company goes to line_dash instead\n",
+    "xpx(stocks.sel(company=[\"GOOG\", \"AAPL\", \"MSFT\"])).line(color=None)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Available Slots\n",
+    "\n",
+    "Different plot types have different slots:\n",
+    "\n",
+    "| Plot | Slots (in order) |\n",
+    "|------|------------------|\n",
+    "| line | x, color, line_dash, facet_col, facet_row, animation_frame |\n",
+    "| scatter | x, color, symbol, facet_col, facet_row, animation_frame |\n",
+    "| bar | x, color, facet_col, facet_row, animation_frame |\n",
+    "| imshow | x, y, facet_col, facet_row, animation_frame |"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# line_dash for third dimension\n",
+    "xpx(stocks.sel(company=[\"GOOG\", \"AAPL\"])).line(line_dash=\"company\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# symbol for scatter\n",
+    "xpx(stocks.sel(company=[\"GOOG\", \"AAPL\"])).scatter(symbol=\"company\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Faceting\n",
+    "\n",
+    "Create a grid of subplots with `facet_col` and `facet_row`:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# One subplot per metric\n",
+    "xpx(data_3d).line(facet_col=\"metric\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Grid: metric x country\n",
+    "xpx(data_3d).line(x=\"year\", facet_col=\"metric\", facet_row=\"country\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Animation\n",
+    "\n",
+    "Animate over a dimension with `animation_frame`:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Animate through years\n",
+    "xpx(data_3d.sel(metric=\"lifeExp\")).bar(x=\"country\", animation_frame=\"year\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Animate heatmap\n",
+    "xpx(data_3d).imshow(animation_frame=\"metric\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.12.0"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

xarray_plotly-0.0.4/docs/examples/figure.ipynb

@@ -0,0 +1,236 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Working with Figures\n",
+    "\n",
+    "All methods return a [Plotly Figure](https://plotly.com/python/figure-structure/) that can be modified and exported."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import plotly.express as px\n",
+    "import plotly.graph_objects as go\n",
+    "import xarray as xr\n",
+    "\n",
+    "from xarray_plotly import config, xpx\n",
+    "\n",
+    "config.notebook()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "df = px.data.stocks().set_index(\"date\")\n",
+    "df.index = df.index.astype(\"datetime64[ns]\")\n",
+    "\n",
+    "stocks = xr.DataArray(\n",
+    "    df.values,\n",
+    "    dims=[\"date\", \"company\"],\n",
+    "    coords={\"date\": df.index, \"company\": df.columns.tolist()},\n",
+    "    name=\"price\",\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## update_layout\n",
+    "\n",
+    "Modify [layout properties](https://plotly.com/python/reference/layout/): title, legend, margins, fonts."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig = xpx(stocks).line()\n",
+    "fig.update_layout(\n",
+    "    title={\"text\": \"Stock Prices\", \"x\": 0.5},\n",
+    "    legend={\"orientation\": \"h\", \"y\": 1.02},\n",
+    ")\n",
+    "fig"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## update_traces\n",
+    "\n",
+    "Modify [trace properties](https://plotly.com/python/reference/): line width, markers, opacity."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig = xpx(stocks).line()\n",
+    "fig.update_traces(line={\"width\": 3})\n",
+    "fig"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig = xpx(stocks).scatter()\n",
+    "fig.update_traces(marker={\"size\": 10, \"opacity\": 0.7})\n",
+    "fig"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## update_xaxes / update_yaxes\n",
+    "\n",
+    "Modify [axis properties](https://plotly.com/python/axes/)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig = xpx(stocks).line()\n",
+    "fig.update_xaxes(rangeslider_visible=True)\n",
+    "fig.update_yaxes(tickformat=\".0%\")\n",
+    "fig"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## add_hline / add_vline\n",
+    "\n",
+    "Add reference lines. See [shapes](https://plotly.com/python/shapes/)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig = xpx(stocks).line()\n",
+    "fig.add_hline(y=1.0, line_dash=\"dash\", line_color=\"gray\", annotation_text=\"Baseline\")\n",
+    "fig.add_vline(x=\"2018-10-01\", line_dash=\"dot\", line_color=\"red\")\n",
+    "fig"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## add_annotation\n",
+    "\n",
+    "Add text annotations. See [annotations](https://plotly.com/python/text-and-annotations/)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig = xpx(stocks).line()\n",
+    "fig.add_annotation(x=\"2018-10-01\", y=1.4, text=\"Peak\", showarrow=True, arrowhead=2)\n",
+    "fig"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## add_trace\n",
+    "\n",
+    "Add custom traces using [Graph Objects](https://plotly.com/python/graph-objects/)."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "fig = xpx(stocks.sel(company=\"GOOG\")).line()\n",
+    "\n",
+    "# Add moving average\n",
+    "goog = stocks.sel(company=\"GOOG\")\n",
+    "ma = goog.rolling(date=20, center=True).mean()\n",
+    "\n",
+    "fig.add_trace(\n",
+    "    go.Scatter(\n",
+    "        x=ma.coords[\"date\"].values,\n",
+    "        y=ma.values,\n",
+    "        mode=\"lines\",\n",
+    "        name=\"20-day MA\",\n",
+    "        line={\"dash\": \"dash\", \"color\": \"red\"},\n",
+    "    )\n",
+    ")\n",
+    "fig"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Export\n",
+    "\n",
+    "### HTML\n",
+    "\n",
+    "See [HTML export](https://plotly.com/python/interactive-html-export/).\n",
+    "\n",
+    "```python\n",
+    "fig.write_html(\"plot.html\")\n",
+    "fig.write_html(\"plot.html\", include_plotlyjs=\"cdn\")  # smaller file\n",
+    "```\n",
+    "\n",
+    "### Images\n",
+    "\n",
+    "Requires [kaleido](https://github.com/plotly/Kaleido): `pip install kaleido`\n",
+    "\n",
+    "See [static image export](https://plotly.com/python/static-image-export/).\n",
+    "\n",
+    "```python\n",
+    "fig.write_image(\"plot.png\")\n",
+    "fig.write_image(\"plot.png\", scale=2)  # higher resolution\n",
+    "fig.write_image(\"plot.svg\")\n",
+    "fig.write_image(\"plot.pdf\")\n",
+    "```"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "name": "python",
+   "version": "3.12.0"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}