| Name | nhc-image-retrieval JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | Downloads images from the NOAA NHC website. |
| upload_time | 2024-08-10 13:16:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | The MIT License (MIT) Copyright © 2024 John Barton Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
hurricane
nhc
image
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
bs4
feedparser
pytz
requests
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NHC Image Retrieval
This is a simple tool to download images from the NOAA NHC website. Today, it retrieves the latest available "uncertainty track" for an active storm in the Atlantic hurricane basin.
## Installation
This library can be installed via `pip`:
```
pip install nhc-image-retrieval
```
### Usage
#### Home Assistant
I initially wrote this library for Home Assistant. I have an automation setup to read from the NHC RSS feeds already - now, when those are read from, my Home Assistant instance also downloads the latest "Uncertainty Track" from the NHC.
This is possible using [AppDaemon](https://appdaemon.readthedocs.io/en/latest/index.html), which can be downloaded as a Home Assistant Add-On.
The example in `examples/home_assistant_appdaemon.py` shows the script I use in my Home Assistant instance.
#### General
For any generic application, I've also included an `examples/main.py` that shows basic usage & the downloading of the Uncertainty Track image.
Raw data
{
"_id": null,
"home_page": null,
"name": "nhc-image-retrieval",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "hurricane, nhc, image",
"author": null,
"author_email": "John Barton <john@mediayoucanfeel.com>",
"download_url": "https://files.pythonhosted.org/packages/2c/a3/3298f10f272ca782257b61cc73df245a30619f62d542da4d122235bca05e/nhc_image_retrieval-0.0.2.tar.gz",
"platform": null,
"description": "# NHC Image Retrieval\nThis is a simple tool to download images from the NOAA NHC website. Today, it retrieves the latest available \"uncertainty track\" for an active storm in the Atlantic hurricane basin.\n\n## Installation\nThis library can be installed via `pip`:\n\n```\npip install nhc-image-retrieval\n```\n\n### Usage\n\n#### Home Assistant\nI initially wrote this library for Home Assistant. I have an automation setup to read from the NHC RSS feeds already - now, when those are read from, my Home Assistant instance also downloads the latest \"Uncertainty Track\" from the NHC.\n\n\n\nThis is possible using [AppDaemon](https://appdaemon.readthedocs.io/en/latest/index.html), which can be downloaded as a Home Assistant Add-On.\n\nThe example in `examples/home_assistant_appdaemon.py` shows the script I use in my Home Assistant instance.\n\n#### General\nFor any generic application, I've also included an `examples/main.py` that shows basic usage & the downloading of the Uncertainty Track image.\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright \u00a9 2024 John Barton Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Downloads images from the NOAA NHC website.",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/JohnBarton27/nhc_image_retrieval"
},
"split_keywords": [
"hurricane",
" nhc",
" image"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f046eeb2907b2c8abf49c3e210b296c95bcf37f60a7c9f72a05b78420300b04",
"md5": "10fb9aa77c15d95d0aef067aa3156287",
"sha256": "a5aa0d0a886dc8133500eb20041780336d691cb535ad3a8683dc57ee78da767f"
},
"downloads": -1,
"filename": "nhc_image_retrieval-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "10fb9aa77c15d95d0aef067aa3156287",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4612,
"upload_time": "2024-08-10T13:16:38",
"upload_time_iso_8601": "2024-08-10T13:16:38.317423Z",
"url": "https://files.pythonhosted.org/packages/4f/04/6eeb2907b2c8abf49c3e210b296c95bcf37f60a7c9f72a05b78420300b04/nhc_image_retrieval-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ca33298f10f272ca782257b61cc73df245a30619f62d542da4d122235bca05e",
"md5": "45e7d5aa02aaa48888b8f7314db3becc",
"sha256": "344d2af232f78e8be5d226b0ae2b7a520cf7428d33f34795a3c53e341ba11aa6"
},
"downloads": -1,
"filename": "nhc_image_retrieval-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "45e7d5aa02aaa48888b8f7314db3becc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 3899,
"upload_time": "2024-08-10T13:16:39",
"upload_time_iso_8601": "2024-08-10T13:16:39.544665Z",
"url": "https://files.pythonhosted.org/packages/2c/a3/3298f10f272ca782257b61cc73df245a30619f62d542da4d122235bca05e/nhc_image_retrieval-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-10 13:16:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JohnBarton27",
"github_project": "nhc_image_retrieval",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "bs4",
"specs": []
},
{
"name": "feedparser",
"specs": []
},
{
"name": "pytz",
"specs": []
},
{
"name": "requests",
"specs": []
}
],
"lcname": "nhc-image-retrieval"
}
