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://sdk-docs.foxglove.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.31.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.31.0
File Size Uploaded Provenance Actions
foxglove_sdk-0.31.0.tar.gz 776.7 kB Without provenance Details for foxglove_sdk-0.31.0.tar.gz

Built distributions (wheels)

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

Total release size: 114.8 MB

Release files / foxglove_sdk-0.31.0.tar.gz

Download URL foxglove_sdk-0.31.0.tar.gz
Size 776.7 kB
Tags Source
SHA-256 checksum
How to use checksums
6d2046b2874066abd3cda5c867683deb804622005e2a40ef2ce865ae859ca593
BLAKE2b-256 checksum
How to use checksums
8c91de3d87c42312e8bc4dc28da439bc39a1514a29046d5141a1165b422d6c0e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-win_amd64.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-win_amd64.whl
Size 16.6 MB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
cb72b2b5b439c7aa0c85d680e286c8d3c4bf4e3adc88e0b8f51789c6653a7f23
BLAKE2b-256 checksum
How to use checksums
36f60c310226f543a50628ffb8d486257a6fb907cf313eba3366e58460de51e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-win32.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-win32.whl
Size 2.5 MB
Tags CPython 3.10 Windows x86-32 abi3
SHA-256 checksum
How to use checksums
fd2f7df8215e2d919256022378f17b523a06f64281db2905e0cc7528dce5003e
BLAKE2b-256 checksum
How to use checksums
8991a6537c1a8c0618738ee9a979a05f25162cf640aacea3e0b719467a725033
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-musllinux_1_2_x86_64.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-musllinux_1_2_x86_64.whl
Size 4.1 MB
Tags CPython 3.10 Linux musl 1.2+ x86-64 abi3
SHA-256 checksum
How to use checksums
3963fcca66fe3bdb8c73ec47936ea1246c5141257431c7f97bbac2c1b52fe652
BLAKE2b-256 checksum
How to use checksums
a2ec3bfa1a8d796b827d75294387c83214744352b691696caf72b337f6ad7d71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-musllinux_1_2_armv7l.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-musllinux_1_2_armv7l.whl
Size 3.5 MB
Tags CPython 3.10 Linux musl 1.2+ ARMv7l abi3
SHA-256 checksum
How to use checksums
e4c0407d64f8ab0ef984185a2e0b6ecf1cd7f2b109faef2f8c8e90c3f6c95ab7
BLAKE2b-256 checksum
How to use checksums
db96db33d6e5597bd0013020cab8bd97cef730a6a272207a039584740c5f8a6c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-musllinux_1_2_aarch64.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-musllinux_1_2_aarch64.whl
Size 4.0 MB
Tags CPython 3.10 Linux musl 1.2+ ARM64 abi3
SHA-256 checksum
How to use checksums
7703fc8c6b629934069daaa4e1c058cdd135497d9f1bf4feccc938bc45857b3d
BLAKE2b-256 checksum
How to use checksums
c6e988c5e362a4e063b3cb5fa4346d1d15213a6b31d426354697fb4550cc7172
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-manylinux_2_28_x86_64.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-manylinux_2_28_x86_64.whl
Size 19.2 MB
Tags CPython 3.10 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
88565e7cdb9337e2f262b5a85d04ecc33df7c494bf8493057651e38dfa5e7a2b
BLAKE2b-256 checksum
How to use checksums
904f1ffe46cb871d11ee5c5a17c209fa19749caa732bdb1593bb38081beb4d52
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-manylinux_2_28_aarch64.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-manylinux_2_28_aarch64.whl
Size 19.2 MB
Tags CPython 3.10 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
f61693cad3551528ef4c4c2aec74a4f6064f45e5e997969dbc05a42b30a8bf8e
BLAKE2b-256 checksum
How to use checksums
120a5784e276125466c2a03ae9c5a7a899d7879aa1ba054daf1bcf26344e8b56
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 3.8 MB
Tags CPython 3.10 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
548854a54745a282e96219dba1dbbe77818773098ee8023e4880bec6b9a690b0
BLAKE2b-256 checksum
How to use checksums
a50c49a5b4fc0fc0ba2d53ea360c95bd94551fa8f4db1ae8ae777296106547e3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-manylinux2014_armv7l.manylinux_2_17_armv7l.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-manylinux2014_armv7l.manylinux_2_17_armv7l.whl
Size 3.3 MB
Tags CPython 3.10 Linux glibc 2.17+ ARMv7l abi3
SHA-256 checksum
How to use checksums
b35fe534bea25a36f3b1f381e6957ebffea1ace7cb3cebf6c3c869c10d83abbb
BLAKE2b-256 checksum
How to use checksums
3c56f59e03ef678e70b580e3f5a74c9775f5326010333e912b83c41df6a731d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 3.8 MB
Tags CPython 3.10 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
dc9c40ebb0574ca5b499a35b88e355826a620c704adb848203c32aaeff4bd235
BLAKE2b-256 checksum
How to use checksums
e003b5d998dcee0eb8f59b16517ecf078e1b8f81efa01ac24048fabdf749f242
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-macosx_11_0_arm64.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-macosx_11_0_arm64.whl
Size 16.4 MB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
435b7aaaef82ad9f0e7cf49fdb02085cb0bfc1349e8ff79be9e1281367b5ecc9
BLAKE2b-256 checksum
How to use checksums
5d24de6c4b1c99bc9cda5c5286fba600d2a3e771ec7966fd4bcf47c5137c5db2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.0-cp310-abi3-macosx_10_12_x86_64.whl

Download URL foxglove_sdk-0.31.0-cp310-abi3-macosx_10_12_x86_64.whl
Size 17.7 MB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
5556b1c74c0378aef7bc9e686c73101d05811be10c5410f31d19f5ee7b34cd08
BLAKE2b-256 checksum
How to use checksums
63956c2645620f5248a0638bef9b336e65d6820597b8ed23fccb4c14af08210d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.31.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.31.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