=====================================
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": ">=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/1e/a4/70faf8e0bd0e41d2f9be7c1d39f25cb496c2b54ab47ce695881ff5c3f37a/pybuoy-0.5.9.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.9",
"project_urls": {
"Bug Tracker": "https://github.com/clairBuoyant/pybuoy/issues",
"Source Code": "https://github.com/clairBuoyant/pybuoy"
},
"split_keywords": [
"ndbc",
" noaa",
" api",
" buoy",
" weather",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "809da6210c097f9d1e427595888508090ba09c439e704ff37ae6aedf740cb360",
"md5": "dc69b22a9db254143c2fd47c3b09e430",
"sha256": "0bc7ab0160908b494767b834d53dd0d24e3c4b53d146c861a7e3c708e2ca6c3c"
},
"downloads": -1,
"filename": "pybuoy-0.5.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc69b22a9db254143c2fd47c3b09e430",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 29265,
"upload_time": "2025-08-13T04:45:48",
"upload_time_iso_8601": "2025-08-13T04:45:48.164572Z",
"url": "https://files.pythonhosted.org/packages/80/9d/a6210c097f9d1e427595888508090ba09c439e704ff37ae6aedf740cb360/pybuoy-0.5.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ea470faf8e0bd0e41d2f9be7c1d39f25cb496c2b54ab47ce695881ff5c3f37a",
"md5": "7b2a8668e5805f180eaa05774c6af6b6",
"sha256": "1fb084ef1c658834162be034cf8fbcd6a7d1a030bf63cc31943a332b3124c4db"
},
"downloads": -1,
"filename": "pybuoy-0.5.9.tar.gz",
"has_sig": false,
"md5_digest": "7b2a8668e5805f180eaa05774c6af6b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 24985,
"upload_time": "2025-08-13T04:45:49",
"upload_time_iso_8601": "2025-08-13T04:45:49.244139Z",
"url": "https://files.pythonhosted.org/packages/1e/a4/70faf8e0bd0e41d2f9be7c1d39f25cb496c2b54ab47ce695881ff5c3f37a/pybuoy-0.5.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-13 04:45:49",
"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
