Reachy 2 SDK
Project description
Python SDK for Reachy 2
Install
Use the following command to install:
$ pip install -e .[dev]
The [dev] option includes tools for developers.
Usage
Check out the examples folder for jupyter notebooks and example scripts.
Documentation
Documentation is generated via pdoc. It can be generated locally with:
pdoc reachy2_sdk --output-dir docs --logo "https://www.pollen-robotics.com/img/company/logo/pollen_logo_square_black.svg"
Unit tests
To ensure everything is functioning correctly, run the unit tests. There are two groups of tests: offline and online. Offline tests check internal functions using mock objects. Online tests require a connection to a simulated robot (e.g., in rviz), and the virtual robot should exhibit movement during these tests.
To execute the tests, use pytest with an optional category:
$ pytest [-m offline|online]
Note that only offline tests are executed by the Continuous Integration/Continuous Deployment (CI/CD) pipeline, as they don't require a gRPC connection.
Camera tests
Camera tests have their own marks because it requires the camera to be plugged to the sdk server (sr_camera and/or teleop_camera).
$ pytest -m [sr_camera | teleop_camera]
Logs
The SDK relies on the python logging system. Set the desired debug level to see messages from the SDK.
import logging
logging.basicConfig(level=logging.DEBUG)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for reachy2_sdk-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff3ffec3a6d2a0a1440372ff91089bfc6c80f41fbeb3a995f48eeaadccc1e035 |
|
MD5 | d6554b9892d7a19072acf45aa967037a |
|
BLAKE2b-256 | 6a7b0405717e77578495b4acecd470a804c489f02739f01e0a4086f1c29d00bd |