Skip to main content

Publish Xarray Datasets via a REST API.

Project description

Xpublish

Publish Xarray Datasets to the web

PyPI Conda PyPI - Python Version Binder

GitHub Workflow Status Documentation Status pre-commit.ci status

A quick example

Serverside: Publish a Xarray Dataset through a rest API

ds.rest.serve(host="0.0.0.0", port=9000)

Client-side: Connect to a published dataset

The published datasets can be accessed from various kinds of client applications, e.g., from within Python using Zarr and fsspec.

import xarray as xr
import zarr
from fsspec.implementations.http import HTTPFileSystem

fs = HTTPFileSystem()
http_map = fs.get_mapper("http://0.0.0.0:9000/zarr/")

# open as a zarr group
zg = zarr.open_consolidated(http_map, mode="r")

# or open as another Xarray Dataset
ds = xr.open_zarr(http_map, consolidated=True)

Or to explore other access methods, open http://0.0.0.0:9000/docs in a browser.

Why?

Xpublish lets you serve/share/publish Xarray Datasets via a web application.

The data and/or metadata in the Xarray Datasets can be exposed in various forms through pluggable REST API endpoints. Efficient, on-demand delivery of large datasets may be enabled with Dask on the server-side.

Xpublish's plugin ecosystem has capabilities including:

  • publish on-demand or derived data products
  • turning xarray objects into streaming services (e.g. OPeNDAP)

How?

Under the hood, Xpublish is using a web app (FastAPI) that is exposing a REST-like API with builtin and/or user-defined endpoints.

For example, Xpublish provides by default a minimal Zarr compatible REST-like API with the following endpoints:

  • zarr/.zmetadata: returns Zarr-formatted metadata keys as json strings.
  • zarr/var/0.0.0: returns a variable data chunk as a binary string.

Futher endpoints can be added by installing or writing plugins.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xpublish-0.4.1.tar.gz (25.2 kB view details)

Uploaded Source

Built Distribution

xpublish-0.4.1-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

Details for the file xpublish-0.4.1.tar.gz.

File metadata

  • Download URL: xpublish-0.4.1.tar.gz
  • Upload date:
  • Size: 25.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xpublish-0.4.1.tar.gz
Algorithm Hash digest
SHA256 03097487817dc7055017098b7f632c3c8cdd9eef0b48c1920ce4849923e60d3f
MD5 1196ed6e4fe5555767a7139af53b5ddc
BLAKE2b-256 9cffe1fb89bec5084b87d1262bf667803238990b1feeccb9b47173b4da0731e6

See more details on using hashes here.

Provenance

The following attestation bundles were made for xpublish-0.4.1.tar.gz:

Publisher: pypipublish.yaml on xpublish-community/xpublish

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xpublish-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: xpublish-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 31.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for xpublish-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 afb93e762a02ddf08d8eaa7a2ec626eaea439529eb6c7de942159afaa8094269
MD5 a1303275862f01d85248e58d99662790
BLAKE2b-256 3295b5d5b7016fd9e5356b7513185567d8a6c336808b51a275d613c567a6cd8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for xpublish-0.4.1-py3-none-any.whl:

Publisher: pypipublish.yaml on xpublish-community/xpublish

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page