From 93d14cfeead4b9a1d47fbcdddee0bbbd06fe285b Mon Sep 17 00:00:00 2001 From: Mike Guida Date: Wed, 25 Mar 2026 20:36:31 -0600 Subject: [PATCH 1/2] organize and note pypi package name --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3a1b42b..d26d974 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,23 @@ [![foxglove-client on PyPI](https://img.shields.io/pypi/v/foxglove-client?label=pypi%20%7C%20foxglove-client)](https://pypi.org/project/foxglove-client/) -This library provides a convenient python client for [Foxglove](https://foxglove.dev/). +A convenient python client for [Foxglove](https://foxglove.dev/). -In order to use the client you will first have to create an API token for your organization on your organization's [settings page](https://app.foxglove.dev/~/settings). +## Getting Started -Read more about the API in the [Foxglove API Docs](https://docs.foxglove.dev/api/). +Install from [PyPi](https://pypi.org/project/foxglove-client/): -## Sample Usage +``` +pip install foxglove-client +``` + +Create an API token for your organization on your organization's [settings page](https://app.foxglove.dev/~/settings) and read more in the [Foxglove API Docs](https://docs.foxglove.dev/api/). Examples of various client features can be found in the `examples` directory. -## Running Tests +## Development + +### Running Tests ```bash pipenv install --dev @@ -21,7 +27,7 @@ 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 Process Release numbering follows a major.minor.patch format, abbreviated as "X.Y.Z" below. From 1704e13306ff466f843901e3a8f9d6758458267b Mon Sep 17 00:00:00 2001 From: Mike Guida Date: Wed, 25 Mar 2026 20:42:21 -0600 Subject: [PATCH 2/2] Update README.md Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d26d974..0abb1f2 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ A convenient python client for [Foxglove](https://foxglove.dev/). ## Getting Started -Install from [PyPi](https://pypi.org/project/foxglove-client/): +Install from [PyPI](https://pypi.org/project/foxglove-client/): ``` pip install foxglove-client