v0.5.5

Security

• 🚨 Address CVE-2024-35195 by updating requests to 2.32.3. (c76ccfe by @kylejb)
• 🚨 Address CVE-2024-34064 by updating jinja2 to 3.1.4. (c76ccfe by @kylejb)
• 🚨 Address CVE-2024-37891 by updating urllib3 to 2.2.2. (c76ccfe by @kylejb)

---

Full Changelog: v0.5.4...v0.5.5

v0.5.4

Security

• 🚨 Address CVE-2024-21503 by replacing vulnerable version of black with ruff. (03f9e3f by @kylejb)
• 🚨 Address CVE-2024-3651 by updating idna to 3.7.0. (03f9e3f by @kylejb)

Internal

• ⚙️ Replace black, flake8, and isort with ruff. (03f9e3f by @kylejb)
• ⚙️ Update all dependencies to latest. (03f9e3f by @kylejb)

---

Full Changelog: v0.5.3...v0.5.4

v0.5.3

Security

• 🚨 Address CVE-2023-37920 by updating certifi to 2023.7.22. (41a59b4 by @kylejb)
• 🚨 Address CVE-2024-22195 by updating jinja2 to 3.1.3. (41a59b4 by @kylejb)
• 🚨 Address CVE-2023-43804 and CVE-2023-43804 by updating urllib3 to 2.1.0. (41a59b4 by @kylejb)

Internal

• ⚙️ Bump all dependencies to latest. (41a59b4 by @kylejb)

v0.5.2

Security

• 🚨 Address CVE-2023-32681 by updating requests to >=2.31.0. (45c73de by @kylejb)
• ⚙️ Bump all dependencies to latest. (45c73de by @kylejb)

v0.5.1

Fixes

• 🐛 Support JSON by replacing NaN with None as default value. (#22 by @kylejb)

Internal

• ⚙️ Bump all dependencies to latest.

v0.5.0

Features

• ✨ Forecasts: get wave and wind forecasts by lat/lon. (#19 by @Grieze, #20 by @kylejb)
  • get returns an iterable ForecastObservations object. The type of iterable provided is ForecastObservation.
  • Special Thanks: @Grieze

Documentation

• ✏️ Add forecast examples. (#19 by @Grieze)
  • Special Thanks: @Grieze

Internal

• ⚙️ Bump all dependencies to latest. (#20 by @kylejb)
• 🚨 Security fix for CVE-2022-23491 by bumping certifi to 2022.12.07. (#20 by @kylejb)

v0.4.3

Documentation

• ✏️ Scaffold and publish documentation for pybuoy. (PR #16 by @kylejb)

Internal

• ⚙️ Bump all development dependencies to latest. (PR #16 by @kylejb)
• ⚙️ Organize dependencies in pyproject.toml by groups (e.g., "dev" and "docs"). (PR #16 by @kylejb)

v0.4.2

Features

mypy

• ✨ Types: realtime.get infers exact return type from user-provided value for dataset. (PR #14 by @kylejb)

ObservationDatum

• ✨ ObservationFloatDatum: validate numeric values (previously named ObservationDatum); .value returns either float or None. (PR #14 by @kylejb)
• ✨ ObservationStringDatum: validate non-numeric values; .value returns either str or None. (PR #14 by @kylejb)

Observation

• ✨ MeteorologicalObservation: attributes return either ObservationFloatDatum or ObservationStringDatum after validating data provided from NDBC. (PR #14 by @kylejb)
• ✨ WaveSummaryObservation: attributes return either ObservationFloatDatum or ObservationStringDatum after validating data provided from NDBC. (PR #14 by @kylejb)

Observations

• ✨ MeteorologicalObservations: can use += syntax on an instance of this class in order to append MeteorologicalObservation records. (PR #14 by @kylejb)
• ✨ WaveSummaryObservations: can use += syntax on an instance of this class in order to append WaveSummaryObservation records. (PR #14 by @kylejb)

Documentation

• ✏️ Remove unnecessary isinstance checks from examples to take advantage of typing improvements introduced in this minor release. (PR #14 by @kylejb)

Internal

• ⚙️ Bump all development dependencies to latest. (PR #14 by @kylejb)
• 🧪 Update tests to include checks for expected attributes by dataset type. (PR #14 by @kylejb)

v0.4.1

Fix

• 🐛 MeteorologicalObservation: change dominate_wave_period to dominant_wave_period. (881c95c by @kylejb)

v0.4.0

Breaking Changes

• ⚠️ Realtime: get returns an iterable Observations object instead of a list of lists containingObservation objects.
• ⚠️ Observation: now represents a collection of data recorded from buoy by unique datetime. Attributes are aligned to NDBC naming conventions.
• ⚠️ ObservationDatum: value will default to None (type: NoneType) when datum missing instead of nan (type: float). This will improve experience when working with JSON objects or databases.

Features

• ✨ Realtime: get now supports Wave Summary data (i.e., dataset="spec"). (PR #12 by @kylejb)
• ✨ mypy: extend type checking support to all library objects and iterables. (PR #12 by @kylejb)

Documentation

• ✏️ Update documentation with clearer installation instructions. (PR #12 by @kylejb)
• ✏️ Update example to include revised responses. (PR #12 by @kylejb)

Internal

• ⚙️ Bump all pre-commit hooks to latest. (PR #12 by @kylejb)
• ⚙️ Bump all dependencies to latest. (PR #12 by @kylejb)