{"id":28598024,"url":"https://github.com/xpublish-community/xpublish","last_synced_at":"2026-03-17T23:38:14.897Z","repository":{"id":37939401,"uuid":"235846200","full_name":"xpublish-community/xpublish","owner":"xpublish-community","description":"Publish Xarray Datasets via a REST API.","archived":false,"fork":false,"pushed_at":"2026-03-16T21:06:16.000Z","size":405,"stargazers_count":200,"open_issues_count":28,"forks_count":35,"subscribers_count":12,"default_branch":"main","last_synced_at":"2026-03-17T07:55:04.995Z","etag":null,"topics":["fast-api","rest-api","xarray"],"latest_commit_sha":null,"homepage":"https://xpublish.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xpublish-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-01-23T17:18:17.000Z","updated_at":"2026-03-08T11:33:44.000Z","dependencies_parsed_at":"2023-09-09T08:13:13.872Z","dependency_job_id":"f7502ac5-3ca1-4749-b0c8-9685f5a9d3b8","html_url":"https://github.com/xpublish-community/xpublish","commit_stats":null,"previous_names":["xarray-contrib/xpublish"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/xpublish-community/xpublish","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xpublish-community%2Fxpublish","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xpublish-community%2Fxpublish/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xpublish-community%2Fxpublish/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xpublish-community%2Fxpublish/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xpublish-community","download_url":"https://codeload.github.com/xpublish-community/xpublish/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xpublish-community%2Fxpublish/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30635281,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T22:38:22.569Z","status":"ssl_error","status_checked_at":"2026-03-17T22:38:11.804Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fast-api","rest-api","xarray"],"created_at":"2025-06-11T11:33:52.385Z","updated_at":"2026-03-17T23:38:14.869Z","avatar_url":"https://github.com/xpublish-community.png","language":"Python","funding_links":[],"categories":["Libraries"],"sub_categories":["Existing lists"],"readme":"# Xpublish\n\nPublish Xarray Datasets to the web\n\n\u003c!-- badges-start --\u003e\n\n[![PyPI](https://img.shields.io/pypi/v/xpublish)](https://pypi.org/project/xpublish/)\n[![Conda](https://img.shields.io/conda/v/conda-forge/xpublish)](https://anaconda.org/conda-forge/xpublish)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xpublish)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/xpublish-community/xpublish/main)\n\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/xpublish-community/xpublish/main.yaml?logo=github)](https://github.com/xpublish-community/xpublish/actions/workflows/main.yaml)\n[![Documentation Status](https://readthedocs.org/projects/xpublish/badge/?version=latest)](https://xpublish.readthedocs.io/en/latest/?badge=latest)\n[![](https://codecov.io/gh/xpublish-community/xpublish/branch/main/graph/badge.svg)](https://codecov.io/gh/xpublish-community/xpublish)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/xpublish-community/xpublish/main.svg)](https://results.pre-commit.ci/latest/github/xpublish-community/xpublish/main)\n\n\u003c!-- badges-end --\u003e\n\n## A quick example\n\n**Serverside: Publish a Xarray Dataset through a rest API**\n\n\u003c!-- server-example-start --\u003e\n\n```python\nds.rest.serve(host=\"0.0.0.0\", port=9000)\n```\n\n\u003c!-- server-example-end --\u003e\n\n**Client-side: Connect to a published dataset**\n\n\u003c!-- client-example-start --\u003e\n\nThe published datasets can be accessed from various kinds of client applications, e.g., from within Python using Zarr and fsspec.\n\n```python\nimport xarray as xr\nimport zarr\nfrom fsspec.implementations.http import HTTPFileSystem\n\nfs = HTTPFileSystem()\nhttp_map = fs.get_mapper(\"http://0.0.0.0:9000/zarr/\")\n\n# open as a zarr group\nzg = zarr.open_consolidated(http_map, mode=\"r\")\n\n# or open as another Xarray Dataset\nds = xr.open_zarr(http_map, consolidated=True)\n```\n\nOr to explore other access methods, open [http://0.0.0.0:9000/docs](http://0.0.0.0:9000/docs) in a browser.\n\n\u003c!-- client-example-end --\u003e\n\n## Why?\n\nXpublish lets you serve/share/publish Xarray Datasets via a web application.\n\nThe data and/or metadata in the Xarray Datasets can be exposed in various forms through [pluggable REST API endpoints](https://xpublish.readthedocs.io/en/latest/user-guide/plugins.html).\nEfficient, on-demand delivery of large datasets may be enabled with Dask on the server-side.\n\nXpublish's [plugin ecosystem](https://xpublish.readthedocs.io/en/latest/ecosystem/index.html#plugins) has capabilities including:\n\n- publish on-demand or derived data products\n- turning xarray objects into streaming services (e.g. OPeNDAP)\n\n## How?\n\nUnder the hood, Xpublish is using a web app (FastAPI) that is exposing a\nREST-like API with builtin and/or user-defined endpoints.\n\nFor example, Xpublish provides by default a minimal Zarr compatible REST-like API with the following endpoints:\n\n- `zarr/.zmetadata`: returns Zarr-formatted metadata keys as json strings.\n- `zarr/var/0.0.0`: returns a variable data chunk as a binary string.\n\nFuther endpoints can be added by installing or writing plugins.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxpublish-community%2Fxpublish","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxpublish-community%2Fxpublish","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxpublish-community%2Fxpublish/lists"}