Skip to main content

Foxglove Python SDK

The official Foxglove SDK for Python.

This package provides support for integrating with the Foxglove platform. It can be used to log events to local MCAP files or a local visualization server that communicates with the Foxglove app.

Get Started

See https://foxglove-sdk-api-docs.pages.dev/python/

Requirements

  • Python 3.10+

Remote Access

The SDK includes optional support for remote access, which enables live visualization and teleop through the Foxglove platform via a gateway connection.

Remote access is available on the following platforms:

Platform Architecture Remote Access
Linux (glibc) x86_64 Yes (manylinux_2_28, glibc >= 2.28)
Linux (glibc) aarch64 Yes (manylinux_2_28, glibc >= 2.28)
Linux (glibc) armv7 No
Linux (musl) x86_64, aarch64, armv7 No
macOS aarch64 Yes
macOS x86_64 Yes
Windows x86_64 Yes
Windows x86 No

On supported platforms, pre-built wheels include remote access. On unsupported platforms the SDK works normally but foxglove.start_gateway will not be available.

When building from source, remote access must be enabled explicitly:

MATURIN_PEP517_ARGS="--features remote-access" pip install .

This requires system dependencies including a C++ toolchain. On Linux, it also requires libva-dev and clang 21 or later; select clang with CC=clang CXX=clang++.

Examples

We're using uv as a Python package manager in the foxglove-sdk-examples.

To test that all examples run (as the CI does) you can use yarn run-python-sdk-examples in the repo root.

To run a specific example (e.g. write-mcap-file) with local changes:

cd python/foxglove-sdk-examples/write-mcap-file
uv run --with ../../foxglove-sdk main.py [args]

Keep in mind that uv does two layers of caching. There's the .venv in your project directory, plus a global cache at ~/.cache/uv.

uv tries to be smart about not rebuilding things it has already built, which means that if you make changes and you want them to show up, you also need to run uv cache clean.

Metadata

Release files for foxglove-sdk 0.30.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for foxglove-sdk 0.30.0
File Size Uploaded Provenance Actions
foxglove_sdk-0.30.0.tar.gz 740.5 kB Without provenance Details for foxglove_sdk-0.30.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for foxglove-sdk 0.30.0
File Actions
foxglove_sdk-0.30.0-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details for foxglove_sdk-0.30.0-cp310-abi3-win_amd64.whl
foxglove_sdk-0.30.0-cp310-abi3-win32.whl CPython 3.10 abi3 Windows x86-32 Details for foxglove_sdk-0.30.0-cp310-abi3-win32.whl
foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_x86_64.whl CPython 3.10 abi3 Linux musl 1.2+ x86-64 Details for foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_x86_64.whl
foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_armv7l.whl CPython 3.10 abi3 Linux musl 1.2+ ARMv7l Details for foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_armv7l.whl
foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_aarch64.whl CPython 3.10 abi3 Linux musl 1.2+ ARM64 Details for foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_aarch64.whl
foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_28_x86_64.whl CPython 3.10 abi3 Linux glibc 2.28+ x86-64 Details for foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_28_x86_64.whl
foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_28_aarch64.whl CPython 3.10 abi3 Linux glibc 2.28+ ARM64 Details for foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_28_aarch64.whl
foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.10 abi3 Linux glibc 2.17+ x86-64 Details for foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl CPython 3.10 abi3 Linux glibc 2.17+ ARMv7l Details for foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl CPython 3.10 abi3 Linux glibc 2.17+ ARM64 Details for foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
foxglove_sdk-0.30.0-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details for foxglove_sdk-0.30.0-cp310-abi3-macosx_11_0_arm64.whl
foxglove_sdk-0.30.0-cp310-abi3-macosx_10_12_x86_64.whl CPython 3.10 abi3 macOS 10.12+ x86-64 Details for foxglove_sdk-0.30.0-cp310-abi3-macosx_10_12_x86_64.whl

Total release size: 104.9 MB

Release files / foxglove_sdk-0.30.0.tar.gz

Download URL foxglove_sdk-0.30.0.tar.gz
Size 740.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1358c30833fb62c644115762433271e0e2bdb6f1af63820d6b8190fad06cb322
BLAKE2b-256 checksum
How to use checksums
fcbfa3ce9c117a875178a4a35281e91fcdbf665c3b87e29c4b947a2b88f31ccc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-win_amd64.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-win_amd64.whl
Size 16.4 MB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
85bae98d77324cfde73ccb6ef329a84385a450357f1f4a07155a683fab807e0a
BLAKE2b-256 checksum
How to use checksums
65aeb3c3bef477861a68c5e4b632f6b43a4d85e7a76b7693c3325cec2818f626
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-win32.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-win32.whl
Size 1.6 MB
Tags CPython 3.10 Windows x86-32 abi3
SHA-256 checksum
How to use checksums
9634ad8879085e0bd725ca6a83963a3b76c97cdc26087495e11b751fdb71cacd
BLAKE2b-256 checksum
How to use checksums
16d6d87265edb687f3039c7862960d70bc235ddab93bb92c26776ef568b4a06c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_x86_64.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_x86_64.whl
Size 2.6 MB
Tags CPython 3.10 Linux musl 1.2+ x86-64 abi3
SHA-256 checksum
How to use checksums
df0db0a48dbeb61d86367b72908b427154ac894d04c124607375322d9e556a54
BLAKE2b-256 checksum
How to use checksums
2c4a620d55a2f03e2483da2ac1f4ecb05cedceefaf92866fca2b1d070a241577
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_armv7l.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_armv7l.whl
Size 2.6 MB
Tags CPython 3.10 Linux musl 1.2+ ARMv7l abi3
SHA-256 checksum
How to use checksums
622d206c96c473df487d47e48429c32370b825b41393b8585f93dd0ac03a71cd
BLAKE2b-256 checksum
How to use checksums
06bfe53c4530787167594ef0a76ca4e06a21f3caffe5b335e3a21dc3c7c07b54
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_aarch64.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-musllinux_1_2_aarch64.whl
Size 2.6 MB
Tags CPython 3.10 Linux musl 1.2+ ARM64 abi3
SHA-256 checksum
How to use checksums
e2b070d48ffab0c91a6da5098a65c0aaff1cdbe3ab2ae0fa7deaa21efff88345
BLAKE2b-256 checksum
How to use checksums
6a1e65d1711e788f9daf4d233e95d37efcac60a539bc589ffbde1df5e57170f2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_28_x86_64.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_28_x86_64.whl
Size 18.9 MB
Tags CPython 3.10 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
b7be5180cd1840f414d74fa3e7c8cf1c9f24c2b51f9452528965a9d0e2d8cef9
BLAKE2b-256 checksum
How to use checksums
51dffb6608c44efa28b318576d4b4c2b5e22345fe4e335290fe05b31bc64421c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_28_aarch64.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_28_aarch64.whl
Size 19.0 MB
Tags CPython 3.10 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
6e69c50df00f1e7a9dcdd5bb66562fb567f3a90307fae62bdf0a20876adb9c07
BLAKE2b-256 checksum
How to use checksums
41398b192da0f46cf075d1a52e08a4cf71b7ae5ce450ffe2ca2e0b9a04f365df
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 2.3 MB
Tags CPython 3.10 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
294510e1c03185239cc099201e4cc1ad164906ff674ad40e0e8ae78020ee17bb
BLAKE2b-256 checksum
How to use checksums
7b83cd044ff5586a181305d065afffb9ebe51d50bc4219ebdc16c79d22499355
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Size 2.3 MB
Tags CPython 3.10 Linux glibc 2.17+ ARMv7l abi3
SHA-256 checksum
How to use checksums
be4b8d4dd48e086d779ded9813e44f33d5581bfa751c77d60950848d9c541a00
BLAKE2b-256 checksum
How to use checksums
90572c42af2c788ace8a1264eeda7b2383c0a9371d3b65a2a70b1ffadf1d07b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 2.4 MB
Tags CPython 3.10 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
75f648d22a7b433685264ae28a0fe3829771803d5604e31d54e41422da1513a9
BLAKE2b-256 checksum
How to use checksums
a640d883534d68ff46fcbc44f240982b6ac894db7f3d3becdd28b765c0680cc4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-macosx_11_0_arm64.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-macosx_11_0_arm64.whl
Size 16.1 MB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
48b095e24119f3a1a5b908e5eb7334d5a3a9ac53fd83091becf6a75ee1c9a5ea
BLAKE2b-256 checksum
How to use checksums
2d125938ef8d2d45ec59cb35c2c12d7d92b6d555bb925fe5421ef53c90e70bf5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / foxglove_sdk-0.30.0-cp310-abi3-macosx_10_12_x86_64.whl

Download URL foxglove_sdk-0.30.0-cp310-abi3-macosx_10_12_x86_64.whl
Size 17.5 MB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
a5fea9f1cc0f6d0b999324b4ee7d91d51921707842fbdb0f7cb5efb9e6afb248
BLAKE2b-256 checksum
How to use checksums
7e7fa1441ebbbfff586a14af62744b398bd8b85aae701923506a1a8dd2ca9865
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.3 {"installer":{"name":"uv","version":"0.13.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for foxglove-sdk 0.30.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.30.0 This release

13 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page