=====================================
pybuoy - Python NOAA/NDBC API Wrapper
=====================================
.. image:: https://img.shields.io/pypi/v/pybuoy?color=blue
:alt: Latest Version
:target: https://pypi.python.org/pypi/pybuoy
.. image:: https://img.shields.io/pypi/pyversions/pybuoy
:alt: Supported Python Versions
:target: https://pypi.python.org/pypi/pybuoy
.. image:: https://img.shields.io/pypi/dm/pybuoy
:alt: PyPI - Monthly Downloads
:target: https://pypi.python.org/pypi/pybuoy
``pybuoy`` is a Python wrapper for `NOAA <https://www.noaa.gov>`_ and `NDBC <https://www.ndbc.noaa.gov>`_ REST web services.
Installation
------------
``pybuoy`` is supported on Python 3.11+ and can be installed with either pip or a package manager like `poetry <https://python-poetry.org>`_:
- **with pip**: ``pip install pybuoy``
- recommended to install any third party library in `python's virtualenv <https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments>`_.
- **with poetry**: ``poetry add pybuoy``
- automatically creates and manages `python's virtualenvs <https://realpython.com/dependency-management-python-poetry>`_.
Quickstart
----------
.. code-block:: python
from pybuoy import Buoy
buoy = Buoy()
With a instance of ``Buoy``, you can request data from NOAA and NDBC like so:
- `Get all active stations <https://pybuoy.readthedocs.io/en/latest/tutorials/active_buoys.html>`_.
- `Get realtime meteorological data <https://pybuoy.readthedocs.io/en/latest/tutorials/realtime_data.html#get-meteorological-data>`_ for buoy by station_id.
- `Get realtime wave summary data <https://pybuoy.readthedocs.io/en/latest/tutorials/realtime_data.html#get-wave-summary-data>`_ for buoy by station_id.
- `Get forecast data <https://pybuoy.readthedocs.io/en/latest/tutorials/forecast_data.html>`_ for buoy by lat/lon.
Raw data
{
"_id": null,
"home_page": null,
"name": "pybuoy",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "NDBC, NOAA, api, buoy, weather, wrapper",
"author": "Kyle J. Burda",
"author_email": "kylejbdev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6f/39/75aa1c1ea2fad5096d453cfa62bdd6c36c6b2fd8ccd4c65aba12450114ff/pybuoy-0.5.6.tar.gz",
"platform": null,
"description": "=====================================\npybuoy - Python NOAA/NDBC API Wrapper\n=====================================\n\n.. image:: https://img.shields.io/pypi/v/pybuoy?color=blue\n :alt: Latest Version\n :target: https://pypi.python.org/pypi/pybuoy\n\n.. image:: https://img.shields.io/pypi/pyversions/pybuoy\n :alt: Supported Python Versions\n :target: https://pypi.python.org/pypi/pybuoy\n\n.. image:: https://img.shields.io/pypi/dm/pybuoy\n :alt: PyPI - Monthly Downloads\n :target: https://pypi.python.org/pypi/pybuoy\n\n\n``pybuoy`` is a Python wrapper for `NOAA <https://www.noaa.gov>`_ and `NDBC <https://www.ndbc.noaa.gov>`_ REST web services.\n\nInstallation\n------------\n\n``pybuoy`` is supported on Python 3.11+ and can be installed with either pip or a package manager like `poetry <https://python-poetry.org>`_:\n\n- **with pip**: ``pip install pybuoy``\n\n - recommended to install any third party library in `python's virtualenv <https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments>`_.\n\n- **with poetry**: ``poetry add pybuoy``\n\n - automatically creates and manages `python's virtualenvs <https://realpython.com/dependency-management-python-poetry>`_.\n\nQuickstart\n----------\n\n.. code-block:: python\n\n from pybuoy import Buoy\n\n buoy = Buoy()\n\n\nWith a instance of ``Buoy``, you can request data from NOAA and NDBC like so:\n\n- `Get all active stations <https://pybuoy.readthedocs.io/en/latest/tutorials/active_buoys.html>`_.\n\n- `Get realtime meteorological data <https://pybuoy.readthedocs.io/en/latest/tutorials/realtime_data.html#get-meteorological-data>`_ for buoy by station_id.\n\n- `Get realtime wave summary data <https://pybuoy.readthedocs.io/en/latest/tutorials/realtime_data.html#get-wave-summary-data>`_ for buoy by station_id.\n\n- `Get forecast data <https://pybuoy.readthedocs.io/en/latest/tutorials/forecast_data.html>`_ for buoy by lat/lon.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Python wrapper for NOAA and NDBC REST web services.",
"version": "0.5.6",
"project_urls": {
"Bug Tracker": "https://github.com/clairBuoyant/pybuoy/issues",
"Documentation": "https://pybuoy.readthedocs.io",
"Source Code": "https://github.com/clairBuoyant/pybuoy"
},
"split_keywords": [
"ndbc",
" noaa",
" api",
" buoy",
" weather",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6cf22066d93a8c6558905d1495a40f86b6b1543ecfd24dbb0b584df446fb2e07",
"md5": "320aae51f48578059ccbff741882873b",
"sha256": "18ee590cbe7ba8dad60abb85cab932aaced51974899c3437cc41f440d04af0a2"
},
"downloads": -1,
"filename": "pybuoy-0.5.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "320aae51f48578059ccbff741882873b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 41549,
"upload_time": "2024-10-19T21:30:17",
"upload_time_iso_8601": "2024-10-19T21:30:17.480437Z",
"url": "https://files.pythonhosted.org/packages/6c/f2/2066d93a8c6558905d1495a40f86b6b1543ecfd24dbb0b584df446fb2e07/pybuoy-0.5.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6f3975aa1c1ea2fad5096d453cfa62bdd6c36c6b2fd8ccd4c65aba12450114ff",
"md5": "1fdfc6d978516847b71ade9403fd0716",
"sha256": "df99b9cb41117ab59d8c6051267b1898ac3e6e7c2fe17796f8f577bc1674b89f"
},
"downloads": -1,
"filename": "pybuoy-0.5.6.tar.gz",
"has_sig": false,
"md5_digest": "1fdfc6d978516847b71ade9403fd0716",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 25879,
"upload_time": "2024-10-19T21:30:19",
"upload_time_iso_8601": "2024-10-19T21:30:19.113948Z",
"url": "https://files.pythonhosted.org/packages/6f/39/75aa1c1ea2fad5096d453cfa62bdd6c36c6b2fd8ccd4c65aba12450114ff/pybuoy-0.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-19 21:30:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "clairBuoyant",
"github_project": "pybuoy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pybuoy"
}
JSON
