Python SDK for Reachy 2
Install
You can install the library either from Pypi, or by cloning the entire repository :
From PyPi
pip install reachy2-sdk -e .
From the source
git clone https://github.com/pollen-robotics/reachy2-sdk.git
cd reachy2-sdk
pip install -e .[dev]
The [dev] option includes tools for developers.
Usage
Check out the examples folder for jupyter notebooks and example scripts. You can also take a look on the Reachy2 Documentation, which provides a more detailed overview of the SDK's various functions.
Documentation
SDK Documentation is generated via pdoc, and it's available at https://pollen-robotics.github.io/reachy2-sdk/reachy2_sdk.html
It can be generated locally with:
pdoc reachy2_sdk --output-dir docs --logo "https://pollen-robotics.github.io/reachy2-sdk/pollen_logo.png" --logo-link "https://www.pollen-robotics.com" --docformat google
You maybe have to install pdoc first by running pip install pdoc.
The documentation relies on the provided docstrings with the google style. pydocstyle is used to enforced this style.
pydocstyle src/ --convention google --count
Unit tests
To ensure everything is functioning correctly, run the unit tests. There are two main 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 cameras to be plugged to the sdk server
$ pytest -m cameras
Audio tests
Audio tests have their own marks.
$ pytest -m audio
Mobile_base tests
Mobile base tests have their own marks as it used to be not supported in Rviz. The tests are based on the Gazebo simulation, so the robot must be launched in Gazebo mode when executing the tests.
$ pytest -m mobile_base
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)
Metadata
Release files for reachy2-sdk 1.0.15
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| reachy2_sdk-1.0.15.tar.gz | 75.1 kB | Without provenance | Details for reachy2_sdk-1.0.15.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| reachy2_sdk-1.0.15-py3-none-any.whl | Python 3 | none | any | Details for reachy2_sdk-1.0.15-py3-none-any.whl |
Total release size: 170.9 kB
Release files / reachy2_sdk-1.0.15.tar.gz
| Download URL | reachy2_sdk-1.0.15.tar.gz |
|---|---|
| Size | 75.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7b99853409008ba4885733af028d2594c0c461db8a8dcda592ae58c851d35ef5
|
|
BLAKE2b-256 checksum How to use checksums |
9b1d54a2c4331eb75d52624705ff311dfa3d7abe536a7bae12607f19d2a97253
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.19
|
Release files / reachy2_sdk-1.0.15-py3-none-any.whl
| Download URL | reachy2_sdk-1.0.15-py3-none-any.whl |
|---|---|
| Size | 95.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
01c542d334a2fff700a4ce2f9798ad9a1a9f82733658bf3ff86093231fc812ca
|
|
BLAKE2b-256 checksum How to use checksums |
6c0788c6c38ecce6556904d365424841e3bf9e20349718cd94b3c149f8fe54dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.19
|
Security for reachy2-sdk 1.0.15
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.