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.
1 maintainer
Metadata
1 maintainer
Release files for foxglove-sdk 0.29.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| foxglove_sdk-0.29.1.tar.gz | 739.3 kB | Details |
Built distributions (wheels)
Total release size: 104.7 MB
Release files / foxglove_sdk-0.29.1.tar.gz
| Download URL | foxglove_sdk-0.29.1.tar.gz |
|---|---|
| Size | 739.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f33b050561a4019cd753013bf0bcb9b8597c9e17b39f6407f34b690e534332f7
|
|
BLAKE2b-256 checksum How to use checksums |
74fba0b4c819314b4f9e3fb907ffa5462eb4a9db275e7c0fa15786675ddbaa3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-win_amd64.whl
| Download URL | foxglove_sdk-0.29.1-cp310-abi3-win_amd64.whl |
|---|---|
| Size | 16.3 MB |
| Tags | CPython 3.10 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
7385651b8503745a78e75489fbed0e8d4e11061110b2ab5ea15d92add6331d86
|
|
BLAKE2b-256 checksum How to use checksums |
28ae79b37a659cab141f80e03a57e8eb0d7a349750a394ab023398699427cb58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-win32.whl
| Download URL | foxglove_sdk-0.29.1-cp310-abi3-win32.whl |
|---|---|
| Size | 1.6 MB |
| Tags | CPython 3.10 Windows x86-32 abi3 |
|
SHA-256 checksum How to use checksums |
9b3bdf2ff8c0a1121b807c546fa83c6fb89014ea083ee85bebea2ae3d22a4718
|
|
BLAKE2b-256 checksum How to use checksums |
f22afc0b78a238210c36f2f0a60fd65f90c66d87d97f98f4bc1a0fa516133495
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-musllinux_1_2_x86_64.whl
| Download URL | foxglove_sdk-0.29.1-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 |
a3974f6ce39635adc910ee3bd7093ba559158de97bcb25bf8743d6eb1348df4c
|
|
BLAKE2b-256 checksum How to use checksums |
4bcf72f26ec19df7799b90cd698126176d4f4d3108bf6e768baa79ddd82a4dab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-musllinux_1_2_armv7l.whl
| Download URL | foxglove_sdk-0.29.1-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 |
924c61de84f292ff5cbf75a088a0b50551213e4210188ee7eb84636a9f3683e3
|
|
BLAKE2b-256 checksum How to use checksums |
8ec61fbe2d879aa1c447c103dbdae32051f1953664469e973bb56e2a9365c527
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-musllinux_1_2_aarch64.whl
| Download URL | foxglove_sdk-0.29.1-cp310-abi3-musllinux_1_2_aarch64.whl |
|---|---|
| Size | 2.5 MB |
| Tags | CPython 3.10 Linux musl 1.2+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
adc82b42ca357017563e6a3435000671e90d1de399c5926b0065086063e815ee
|
|
BLAKE2b-256 checksum How to use checksums |
ca0d3ff39c4303911f0868bf6f54387b45c863477a8c8fc399e400aab223bd07
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-manylinux_2_28_x86_64.whl
| Download URL | foxglove_sdk-0.29.1-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 |
2d29395b4b7589e493dea9735cf3d2b4d72863b46e5578194de6026ceed85de6
|
|
BLAKE2b-256 checksum How to use checksums |
789ddbef927d9bbd3d7734924f2a6822eac672c42713189790cbfe75355ed0a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-manylinux_2_28_aarch64.whl
| Download URL | foxglove_sdk-0.29.1-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 |
c4dc65d5a0f94de67482a9d04d17e80c88e83b76dc1828e223673cc3c9b3fd17
|
|
BLAKE2b-256 checksum How to use checksums |
29561b2659c4b2824988a53daa2de2b9cfa56c25356f84c40c2674cc8f531ce7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | foxglove_sdk-0.29.1-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 |
58b7e0291b5be20eb7f973c30758bf0145ca79d1c8da8c580f73fd30d69efebd
|
|
BLAKE2b-256 checksum How to use checksums |
205fce1e0c69d470de899321bc07cd23e4591d9230699ce0c97d48514a03f2c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
| Download URL | foxglove_sdk-0.29.1-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 |
7b7de3df244f29de72780d3867be6d3304922934b0399712e945d40c581fb1a7
|
|
BLAKE2b-256 checksum How to use checksums |
287c3401b903d7aac40f98979bc2d6227d0d5fecd1c716b613548d8d780bd312
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | foxglove_sdk-0.29.1-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 |
ca3e2edcd203c3b1a5bda1b08b44998208279b656ab5bce29786b666462439ac
|
|
BLAKE2b-256 checksum How to use checksums |
11d16480a76b5f6d9f3d7880f673d864b4acba6a95c1abaab84901f0c39ccf07
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-macosx_11_0_arm64.whl
| Download URL | foxglove_sdk-0.29.1-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 |
af2e53e1645f7ce2f665cb47a812dc3eac37e1c3d1e4ccbeb1ec3cbce260f02a
|
|
BLAKE2b-256 checksum How to use checksums |
a1451974aa77018ceaed9c547e5c0f719205c0653cff3f0dcd8989bfa3db2735
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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.29.1-cp310-abi3-macosx_10_12_x86_64.whl
| Download URL | foxglove_sdk-0.29.1-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 |
559bd8ab8768ddee322e1bf4d4b1a01a2c46c20708a4f22d8a5d4b6aee1715b1
|
|
BLAKE2b-256 checksum How to use checksums |
8c2f5e1a5709d48e159b5d21c1265c230497399edc0ff1793b130b93bf7374a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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}
|
