Repository Migration Notice

Important

This repository has moved to the RAI-Opensource GitHub organization!

Current status: Migrated.

• Migration target org: https://github.com/RAI-Opensource
• Previous target org: https://github.com/bdaiinstitute

What to do now:

• Update your git remote:

  git remote set-url origin https://github.com/RAI-Opensource/spot_wrapper

• If you maintain downstream docs/scripts, 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.