clairbuoyant / pybuoy Goto Github PK

Task

• Document API methods and classes.
• Consider automated doc generation tools like sphinx to streamline maintenance.
• Hosting solutions (e.g., GitHub pages with Sphinx).

Currently pybuoy as it stands is only capable of pulling current and historical data for meteorological and wave conditions. This feature seeks to implement a forecast class which would be responsible for making calls to a NOAA database that provides forecast wind speed, direction, gust, and wave height data for specific geographical points.

Acceptance Criteria:

• Forecast class that is solely responsible for making calls to the NOAA NDFD to retrieve forecast surf data
• Ability to parse NDFD XML data
• Present parsed data as an Observations class or even Forecasts class for clients to be able to work with

Additional Info:
Potentially refactor code base to support more flexible and robust code by creating base classes for observation and forecasts. Up for debate.

What

Support clairBuoyant/server#42 by providing stub files to extend support for mypy.

How

• Create .pyi files with type definitions.
• Add mypy to dev dependencies and create script to run mypy to test.
  • script should mimic patterns and naming conventions set forth in server/web scripts folder.

Why

Enables end-users to use mypy with pybuoy.

Issue

We should not require station_id if user only seeks to retrieve a list of all active stations.

Example from clairBuoyant/server.

Possible Solutions

• Provide station_id as an argument for every data request.
• Redesign the superclass to allow for instance reuse (e.g., expose setter method to update instance's self.station_id).

Task

Investigate alternative ways we can represent missing data in Observation without defaulting to -1.

Describe the solution you'd like

Ideally, we should set this value to None, as it's both falsey and clearly represents data is missing.

Additional Information

For currently supported endpoints (i.e., realtime2), NDBC represents missing data with 'MM' (type: string).