OSHConnect-Python

Library for communicating with Opensensorhub that provides options for saving configurations, getting visualization recommendations for data, retrieving data in real time, archival streams, and batch modes, and more.

API Documentation available here

Links:

• Architecture Doc
• UML Diagram

The documentation is built with Sphinx. Dev dependencies (including Sphinx) are installed automatically with:

uv sync

Then build the HTML docs:

uv run sphinx-build -b html docs/source docs/build/html

The output will be in docs/build/html/. Open docs/build/html/index.html in a browser to view locally.

To do a clean rebuild:

uv run sphinx-build -E -b html docs/source docs/build/html

The -E flag forces Sphinx to re-read all source files rather than using cached data.