| Name | xpublish-intake-provider JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | Use Intake catalogs to load datasets into Xpublish |
| upload_time | 2023-10-12 15:09:40 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | Copyright 2017 AUTHOR NAME Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
aiohttp
intake
numpy
requests
xpublish
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
## Xpublish-Intake-Provider
Xpublish-Intake-Provider allows serving datasets with Xpublish specified by Intake catalogs.
### Installation
For `conda` users you can
```shell
conda install --channel conda-forge xpublish_intake_provider
```
or, if you are a `pip` users
```shell
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.
```python
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](https://github.com/ioos/xpublish_intake_provider/issues).
## 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>.
Raw data
{
"_id": null,
"home_page": "",
"name": "xpublish-intake-provider",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Alex Kerney <akerney@gmri.org>",
"download_url": "https://files.pythonhosted.org/packages/26/e4/9ffca5b87f9ab5394f7a47d56a4482ebe49dcc7543779471a2dd76b7f732/xpublish-intake-provider-0.1.1.tar.gz",
"platform": null,
"description": "## Xpublish-Intake-Provider\n\nXpublish-Intake-Provider allows serving datasets with Xpublish specified by Intake catalogs.\n\n### Installation\n\nFor `conda` users you can\n\n```shell\nconda install --channel conda-forge xpublish_intake_provider\n```\n\nor, if you are a `pip` users\n\n```shell\npip install xpublish_intake_provider\n```\n\n### Example\n\nCurrently this package includes one plugin which can load an\nIntake catalog and serve it's datasets via `/datasets/{dataset_id}`.\n\nYou can register the plugin multiple times in order to serve\nmultiple catalogs as long as each gets its own name.\n\n```python\nfrom xpublish_intake_provider import IntakeDatasetProviderPlugin\n\nrest = xpublish.Rest({})\n\nrest.register_plugin(\n IntakeDatasetProviderPlugin(\n name=\"gfs-datasets\",\n uri=\"https://raw.githubusercontent.com/axiom-data-science/mc-goods/main/mc_goods/gfs-1-4deg.yaml\"\n )\n)\nrest.register_plugin(\n IntakeDatasetProviderPlugin(\n name=\"gomofs-datasets\",\n uri=\"https://raw.githubusercontent.com/axiom-data-science/mc-goods/main/mc_goods/gomofs.yaml\"\n )\n)\n```\n\n## Get in touch\n\nReport bugs, suggest features or view the source code on [GitHub](https://github.com/ioos/xpublish_intake_provider/issues).\n\n\n## License and copyright\n\nxpublish_intake_provider is licensed under BSD 3-Clause \"New\" or \"Revised\" License (BSD-3-Clause).\n\nDevelopment occurs on GitHub at <https://github.com/ioos/xpublish_intake_provider>.\n",
"bugtrack_url": null,
"license": "Copyright 2017 AUTHOR NAME Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Use Intake catalogs to load datasets into Xpublish",
"version": "0.1.1",
"project_urls": {
"homepage": "https://github.com/xpublish-community/xpublish-intake-provider",
"repository": "https://github.com/xpublish-community/xpublish-intake-provider"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1ba2c8d5553284049b1ea5f7d4989c763c605225f21a0d05aada999eaa3513c2",
"md5": "b13351b376aa19ed9b1c7f3256b88027",
"sha256": "bfc2fd468b8ca18ae9fa60a7aee32574cbbbce58a60100c9f020d841fd875ad9"
},
"downloads": -1,
"filename": "xpublish_intake_provider-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b13351b376aa19ed9b1c7f3256b88027",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5088,
"upload_time": "2023-10-12T15:09:39",
"upload_time_iso_8601": "2023-10-12T15:09:39.840159Z",
"url": "https://files.pythonhosted.org/packages/1b/a2/c8d5553284049b1ea5f7d4989c763c605225f21a0d05aada999eaa3513c2/xpublish_intake_provider-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26e49ffca5b87f9ab5394f7a47d56a4482ebe49dcc7543779471a2dd76b7f732",
"md5": "7165a2bdfdeb262c8ca51661e70f76db",
"sha256": "821d89f339c26f2e386579482b2ff5f89879ccc29933d24a333f577b28b784e2"
},
"downloads": -1,
"filename": "xpublish-intake-provider-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "7165a2bdfdeb262c8ca51661e70f76db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6787,
"upload_time": "2023-10-12T15:09:40",
"upload_time_iso_8601": "2023-10-12T15:09:40.893511Z",
"url": "https://files.pythonhosted.org/packages/26/e4/9ffca5b87f9ab5394f7a47d56a4482ebe49dcc7543779471a2dd76b7f732/xpublish-intake-provider-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-12 15:09:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xpublish-community",
"github_project": "xpublish-intake-provider",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "aiohttp",
"specs": []
},
{
"name": "intake",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "xpublish",
"specs": []
}
],
"lcname": "xpublish-intake-provider"
}
