Skip to main content

Use Intake catalogs to load datasets into Xpublish

Project description

Xpublish-Intake-Provider

Xpublish-Intake-Provider allows serving datasets with Xpublish specified by Intake catalogs.

Installation

For conda users you can

conda install --channel conda-forge xpublish_intake_provider

or, if you are a pip users

pip install xpublish_intake_provider

Example

Currently this package includes one plugin which can load an Intake catalog and serve it's datasets via /datasets/{dataset_id}.

You can register the plugin multiple times in order to serve multiple catalogs as long as each gets its own name.

from xpublish_intake_provider import IntakeDatasetProviderPlugin

rest = xpublish.Rest({})

rest.register_plugin(
    IntakeDatasetProviderPlugin(
        name="gfs-datasets",
        uri="https://raw.githubusercontent.com/axiom-data-science/mc-goods/main/mc_goods/gfs-1-4deg.yaml"
    )
)
rest.register_plugin(
    IntakeDatasetProviderPlugin(
        name="gomofs-datasets",
        uri="https://raw.githubusercontent.com/axiom-data-science/mc-goods/main/mc_goods/gomofs.yaml"
    )
)

Get in touch

Report bugs, suggest features or view the source code on GitHub.

License and copyright

xpublish_intake_provider is licensed under BSD 3-Clause "New" or "Revised" License (BSD-3-Clause).

Development occurs on GitHub at https://github.com/ioos/xpublish_intake_provider.

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-intake-provider-0.1.1.tar.gz (6.8 kB view hashes)

Uploaded Source

Built Distribution

xpublish_intake_provider-0.1.1-py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 3

Supported by

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