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 libva-dev (Linux) and a C++ toolchain.

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

foxglove_sdk-0.26.0.tar.gz (566.0 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

foxglove_sdk-0.26.0-cp310-abi3-win_amd64.whl (16.0 MB view details)

Uploaded CPython 3.10+Windows x86-64

foxglove_sdk-0.26.0-cp310-abi3-win32.whl (1.5 MB view details)

Uploaded CPython 3.10+Windows x86

foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_x86_64.whl (2.5 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ x86-64

foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_armv7l.whl (2.5 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARMv7l

foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_aarch64.whl (2.5 MB view details)

Uploaded CPython 3.10+musllinux: musl 1.2+ ARM64

foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_28_x86_64.whl (18.5 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ x86-64

foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_28_aarch64.whl (18.2 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ ARM64

foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ x86-64

foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (2.2 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARMv7l

foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (2.3 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

foxglove_sdk-0.26.0-cp310-abi3-macosx_11_0_arm64.whl (15.6 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

foxglove_sdk-0.26.0-cp310-abi3-macosx_10_12_x86_64.whl (17.0 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

Details for the file foxglove_sdk-0.26.0.tar.gz.

File metadata

  • Download URL: foxglove_sdk-0.26.0.tar.gz
  • Upload date:
  • Size: 566.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0.tar.gz
Algorithm Hash digest
SHA256 79def3c5699da30763a500c99801a2e7aa02652cfc202c1e79478a04e964cfa6
MD5 df57ce19c9a14d50c8edd5049dd01556
BLAKE2b-256 1c9df8abcea4ea831b9ae4ace9227abad2b567f0c34503a61e7be5060eea506f

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 16.0 MB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 ddf3ef76099e3e9e32ffb3e21e1d4a2485b99d860cc86a865420dc6617d55800
MD5 5b8ba4292b73fde3b8eef012f3e87df1
BLAKE2b-256 8cee3f3bd3e984f8d641e1753f89458cb4f9d85d629c86157c24f93ab3e2d0b5

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-win32.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-win32.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: CPython 3.10+, Windows x86
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-win32.whl
Algorithm Hash digest
SHA256 e1e1f4fa1b9b371dfb1f39a3c51bd3b0841da36ff5e973fd62e8a98fb417271e
MD5 df76926975da2965bbaef83d5ac24600
BLAKE2b-256 0128ff6219aa88fccec1213433c46da4e811fcd81433a947c11d6d2261490e4e

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_x86_64.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_x86_64.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: CPython 3.10+, musllinux: musl 1.2+ x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 65f299a53c447c92646d2d1cc3b3f5ca12de6e7ef85727d09d2c2d077ff7fadb
MD5 169c70e078804461a68a96a791350218
BLAKE2b-256 0d4f2447874458617e72e9215bdc047ac0f7eef8321081f1d842af70ede3a3e0

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_armv7l.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_armv7l.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: CPython 3.10+, musllinux: musl 1.2+ ARMv7l
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_armv7l.whl
Algorithm Hash digest
SHA256 d437dd97f8f6ca5f3da42b1d60c51153689a8cd85eb9a289549e0e9480282dc2
MD5 8abd3f23efdb40249f4e1cedb040d006
BLAKE2b-256 8da78e429268ca9ccce3d7794d06f6bfcc16a838a27a67a01721071c26ff1e8c

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_aarch64.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_aarch64.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: CPython 3.10+, musllinux: musl 1.2+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 eddcb6d8d9d1a3824dced3fd6917d58dd182b38901110bc6d06c41ce29071693
MD5 0ce96eedb2dc8e7fffff6be749a5d018
BLAKE2b-256 3476e9a987b56ddf2543726132e0489bad2ae0c75447478610a6bf126b06a44f

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_28_x86_64.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_28_x86_64.whl
  • Upload date:
  • Size: 18.5 MB
  • Tags: CPython 3.10+, manylinux: glibc 2.28+ x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ab242e1dcdf117675438d4aaa29acc4c8f76e889e3446bfe6bc401895342cf70
MD5 7ebe76284bc674cf815f32c13f6c590a
BLAKE2b-256 7dbd3405c05e6c8d3ddea7f4c1a783b028db91355fb12a959628f975b17a85cd

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_28_aarch64.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_28_aarch64.whl
  • Upload date:
  • Size: 18.2 MB
  • Tags: CPython 3.10+, manylinux: glibc 2.28+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 d3bd04de9c6f0c5c9d2d5eea9e411d8ba79931879450f2b3288e8aaeba3c11d6
MD5 a7a901ab784485933f1e2b92430872e8
BLAKE2b-256 4760a2cd7c9ad755e56ed677db17161dcb32a6d1a7dcb7003561064cafa4e747

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
  • Upload date:
  • Size: 2.2 MB
  • Tags: CPython 3.10+, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c964e9849865568686af14753e5ba0797a2b45051ef9c6be9d927065a21631c9
MD5 5674339ba9ec0408e9178b70129c87b4
BLAKE2b-256 3ded3e91daf06df9600529d9cc7527f690636e25e1f3d00d355167412a54f96a

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
  • Upload date:
  • Size: 2.2 MB
  • Tags: CPython 3.10+, manylinux: glibc 2.17+ ARMv7l
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm Hash digest
SHA256 20fcb155c7b73695bf15eb469b04817c44411b82a27aed890723ae0d78fced44
MD5 e2b84e83d5b7925ec18eba92552dbeb7
BLAKE2b-256 1795faaa702328cdea490d297fa483579a3f9d5dd50199ddc815da70efd63d25

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: CPython 3.10+, manylinux: glibc 2.17+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 1d05eafe59d19a4b0eaef4e44ee6220b72f0f3c704e2913f3e072adefd76de09
MD5 86ebfbc48c1848fc24b9ee0034287882
BLAKE2b-256 80dea3973aee349e1ef697a1b4d012b46ef292035210529a8f295fe702d13a14

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 15.6 MB
  • Tags: CPython 3.10+, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c26d0be9f2deb8757903dd26c0998cb39c67cac2ec2d9383f670733d24dfcf0a
MD5 e5509b80938580c977f8e4b10d98cde3
BLAKE2b-256 176e06c3f5d27aab857be256401cfb12f27c6e665ffe2aa182af3431893be52d

See more details on using hashes here.

File details

Details for the file foxglove_sdk-0.26.0-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: foxglove_sdk-0.26.0-cp310-abi3-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 17.0 MB
  • Tags: CPython 3.10+, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.30 {"installer":{"name":"uv","version":"0.11.30","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}

File hashes

Hashes for foxglove_sdk-0.26.0-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 f9b032667277fff8e7cafe3aef61d91b13d0595d9aea7b69eb92a5169756c800
MD5 de2e23ea92f54b2801df5bd05a3ac568
BLAKE2b-256 4f870cb1116e2432b45dba52ef525dcfe59c55f9e19404db374d5dc8797ad721

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page