Python Client Library for the Foxglove API

A convenient python client for Foxglove.

Getting Started

Install from PyPI:

pip install foxglove-client

Create an API token for your organization on your organization's settings page and read more in the Foxglove API Docs.

Examples of various client features can be found in the examples directory.

Development

Running Tests

pipenv install --dev
pipenv run python -m pytest

In addition to unit tests, all PRs that change behavior should also be tested against the Foxglove API.

Release Process

Release numbering follows a major.minor.patch format, abbreviated as "X.Y.Z" below.

CI will build the package and publish to PyPI once tags are pushed, as described below.

1. Update the version in setup.cfg with the new version X.Y.Z
2. Draft a release on GitHub and create a new tag releases/vX.Y.Z
3. Generate release notes, review, and publish the release

Stay in touch

Join our Discord to ask questions, share feedback, and stay up to date on what our team is working on.