Repository Migration Notice

Important

This repository is moving to the RAI-Opensource GitHub organization in about 2 weeks from April 9, 2026 (UTC).

Current status: pre-migration. Migration target org: https://github.com/RAI-Opensource

What to do now:

• Watch this repository for the final cutover update and destination repository link.

• Plan to update your git remote after the move:

  git remote set-url origin <new-repository-url>

• If you maintain downstream docs/scripts, prepare to update links from this repository to the new org.

Spot Wrapper

This Python package is a wrapper around the Boston Dynamics Spot SDK, intended as a united point of entry to the SDK for use with the spot_ros and spot_ros2 packages.

This package currently corresponds to spot-sdk release 5.0.1. The minimum supported version of Python this package supports is 3.10.

Installation

To install this package clone it and run

pip3 install -e .

The -e flag means that you will not have to reinstall the package when pulling or making changes.

Updating

To update requirements.txt, use

pipreqs . --force

Contributing

This repository enforces ruff and black linting. To verify that your code will pass inspection, install pre-commit and run:

pre-commit install
pre-commit run --all-files

The Google Style Guide is followed for default formatting.