api_24sea#

Facilitate the users’ interaction with the 24SEA API (https://api/24sea/eu) by providing pandas interfaces to the API endpoints.

The subpackages are:

  • api_24sea.datasignals: Contains:

    • api_24sea.datasignals.DataSignals class, which is an accessor for transforming data signals from the 24SEA API into pandas DataFrames.

    • api_24sea.datasignals.core: Contains the core API and AsyncAPI classes, providing synchronous and asynchronous interfaces for interacting with the 24SEA API - DataSignals app. Serialization/deserialization methods are also provided to save and load API instances with their authentication state.

    • api_24sea.datasignals.fatigue: Contains the FatigueAccessor class, which is a pandas DataFrame accessor for converting cycle-count columns into py_fatigue.CycleCount objects.

    • api_24sea.datasignals.schemas: Contains pydantic models for validating input parameters.

The submodules are:

  • api_24sea.abc: Contains the AuthABC abstract base class, which provides a common interface for authentication classes.

  • api_24sea.exceptions: Contains custom exceptions for the package.

  • api_24sea.singleton: Contains the Singleton class, which is a metaclass to facilitate the implementation usage with and without extras.

  • api_24sea.utils: Contains utility functions and classes to help manage requests to the 24SEA API.

  • api_24sea.version: Contains the version number of the package.

Submodules#