Add stubs package

Author: FBumann

stubs-package/README.md

@@ -0,0 +1,27 @@
+# xarray_plotly_stubs
+
+Type stubs for [xarray_plotly](https://github.com/felix/xarray_plotly).
+
+## Installation
+
+```bash
+pip install xarray_plotly_stubs
+```
+
+This package provides type hints for the `da.plotly` accessor added by xarray_plotly.
+
+## Usage
+
+After installing, type checkers will recognize the `plotly` accessor on xarray DataArrays:
+
+```python
+import xarray as xr
+import xarray_plotly  # registers the accessor
+
+da = xr.DataArray(...)
+fig = da.plotly.line()  # Now properly typed!
+```
+
+## Note
+
+Install this package alongside `xarray_plotly` for full type checking support.

stubs-package/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "xarray_plotly_stubs"
+version = "0.0.1"
+description = "Type stubs for xarray_plotly"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.10"
+authors = [{ name = "Felix" }]
+keywords = ["xarray", "plotly", "stubs", "typing"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Typing :: Stubs Only",
+]
+dependencies = [
+    "xarray_plotly",
+]
+
+[project.urls]
+Homepage = "https://github.com/felix/xarray_plotly"
+Repository = "https://github.com/felix/xarray_plotly"
+
+[build-system]
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["xarray_plotly_stubs*", "xarray-stubs*"]
+
+[tool.setuptools.package-data]
+"*" = ["*.pyi", "py.typed"]

stubs-package/xarray-stubs/__init__.pyi

@@ -0,0 +1,13 @@
+"""Partial type stubs for xarray - adds plotly accessor to DataArray."""
+
+from typing import Any
+
+from xarray_plotly.accessor import DataArrayPlotlyAccessor
+
+# Re-export everything from xarray
+from xarray import *
+
+# Augment DataArray with the plotly accessor
+class DataArray(DataArray):
+    @property
+    def plotly(self) -> DataArrayPlotlyAccessor: ...

stubs-package/xarray-stubs/py.typed

@@ -0,0 +1 @@
+partial

stubs-package/xarray_plotly_stubs/__init__.pyi

@@ -0,0 +1 @@
+"""Type stubs for xarray_plotly."""