pynws


Namepynws JSON
Version 1.8.1 PyPI version JSON
download
home_pageNone
SummaryPython library to retrieve observations and forecasts from NWS/NOAA
upload_time2024-05-13 18:53:29
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License
keywords nws weather
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # pynws

A python library to asynchronously retrieve weather observation from NWS/NOAA.

![PyPI - Downloads](https://img.shields.io/pypi/dm/pynws?style=flat-square)

## Example
See [example.py](example.py) for a runnable example.
```python
PHILLY = (39.95, -75.16)
USERID = "testing@address.xyz"

async def example():
    async with aiohttp.ClientSession() as session:
        nws = pynws.SimpleNWS(*PHILLY, USERID, session)
        await nws.set_station()
        await nws.update_observation()
        await nws.update_forecast()
        await nws.update_alerts_forecast_zone()
        print(nws.observation)
        print(nws.forecast[0])
        print(nws.alerts_forecast_zone)
```

## Functionality
pynws exposes the ability to retrieve raw data using `raw_data` module. `Nws` class offers ability to retrieve minimally processed data for a single location.  `SimpleNWS` class offers data caching and several other helpers for interpreting output.


### Units for Observations in SimpleNWS
NWS API does not expose all possible units for observations.  Known units are converted to the following:

|unit type   | known NWS units| pynws unit |
|------------|----------------|------------|
|temperature | degF, degC     | Celsius    |
|pressure    | Pa             | Pascal     |
|speed       | m_s-1, km_h-1  | km_h-1     |
|percent     | percent        | percent    |
|angle       | degree_(angle) | degrees    |
|distance    | m              | meter      |

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pynws",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "nws, weather",
    "author": null,
    "author_email": "Matthew Flamm <matthewhflamm0@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/bf/1a/130ced6afce4699578d244260ddbc06bfb94a0f47a14e1037117291c4ec3/pynws-1.8.1.tar.gz",
    "platform": null,
    "description": "# pynws\n\nA python library to asynchronously retrieve weather observation from NWS/NOAA.\n\n![PyPI - Downloads](https://img.shields.io/pypi/dm/pynws?style=flat-square)\n\n## Example\nSee [example.py](example.py) for a runnable example.\n```python\nPHILLY = (39.95, -75.16)\nUSERID = \"testing@address.xyz\"\n\nasync def example():\n    async with aiohttp.ClientSession() as session:\n        nws = pynws.SimpleNWS(*PHILLY, USERID, session)\n        await nws.set_station()\n        await nws.update_observation()\n        await nws.update_forecast()\n        await nws.update_alerts_forecast_zone()\n        print(nws.observation)\n        print(nws.forecast[0])\n        print(nws.alerts_forecast_zone)\n```\n\n## Functionality\npynws exposes the ability to retrieve raw data using `raw_data` module. `Nws` class offers ability to retrieve minimally processed data for a single location.  `SimpleNWS` class offers data caching and several other helpers for interpreting output.\n\n\n### Units for Observations in SimpleNWS\nNWS API does not expose all possible units for observations.  Known units are converted to the following:\n\n|unit type   | known NWS units| pynws unit |\n|------------|----------------|------------|\n|temperature | degF, degC     | Celsius    |\n|pressure    | Pa             | Pascal     |\n|speed       | m_s-1, km_h-1  | km_h-1     |\n|percent     | percent        | percent    |\n|angle       | degree_(angle) | degrees    |\n|distance    | m              | meter      |\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Python library to retrieve observations and forecasts from NWS/NOAA",
    "version": "1.8.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/MatthewFlamm/pynws/issues",
        "Repository": "https://github.com/MatthewFlamm/pynws"
    },
    "split_keywords": [
        "nws",
        " weather"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3e4b499fccd25b447888ab29efd55068b6decedc6d87130c1037912ef4d225c6",
                "md5": "4f9e6e5a6b18fee15d2a27c0aaf77f05",
                "sha256": "233a6f54c9a19de304f54ba548743ce01f2dd2f96066819b0a7da48459b0325e"
            },
            "downloads": -1,
            "filename": "pynws-1.8.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4f9e6e5a6b18fee15d2a27c0aaf77f05",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 16595,
            "upload_time": "2024-05-13T18:53:27",
            "upload_time_iso_8601": "2024-05-13T18:53:27.992663Z",
            "url": "https://files.pythonhosted.org/packages/3e/4b/499fccd25b447888ab29efd55068b6decedc6d87130c1037912ef4d225c6/pynws-1.8.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bf1a130ced6afce4699578d244260ddbc06bfb94a0f47a14e1037117291c4ec3",
                "md5": "c353e741af490483b4abf80b52452d61",
                "sha256": "0f5f63da244bdf4285fa3ae7dc460f9e62f2386a59de7c487f8a6c01b449502f"
            },
            "downloads": -1,
            "filename": "pynws-1.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "c353e741af490483b4abf80b52452d61",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 43361,
            "upload_time": "2024-05-13T18:53:29",
            "upload_time_iso_8601": "2024-05-13T18:53:29.831714Z",
            "url": "https://files.pythonhosted.org/packages/bf/1a/130ced6afce4699578d244260ddbc06bfb94a0f47a14e1037117291c4ec3/pynws-1.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-13 18:53:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MatthewFlamm",
    "github_project": "pynws",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "pynws"
}
        
Elapsed time: 0.29007s