Skip to content

organize and note pypi package name #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mguida22 merged 2 commits into from
Mar 27, 2026
Merged

organize and note pypi package name #154

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
93d14cf
organize and note pypi package name
mguida22 Mar 26, 2026
1704e13
Update README.md
mguida22 Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down
Loading