Stretch Body low level Python API
Project description
Stretch Body
The stretch_body package provides a low level Python API to the Hello Robot Stretch hardware. This package comes pre-installed on Stretch robots. Tutorials for using this package can be found on the docs.
Installing
This package comes pre-installed on Stretch robots. To install or upgrade to a stable Stretch Body for Python3, run:
$ python3 -m pip install --upgrade hello-robot-stretch-body
To install or upgrade to a pre-release of Stretch Body for Python3, run:
$ python3 -m pip install --upgrade --pre hello-robot-stretch-body
Please report feedback on the Issue Tracker or the Forum.
Running tests
There are a number of unit, functional, and performance tests within the test/
folder, separated into test suites by different files. Suites are separated by a device or functionality within Stretch Body that is being tested.
In Python3, run python3 -m unittest test.test_<suite-name>
.
For example, to run the stretch_body.robot.Robot
functional tests, run:
$ git clone https://github.com/hello-robot/stretch_body.git
$ cd stretch_body/body
$ python3 -m unittest test.test_robot
Developing
The source code for Stretch Body resides within the stretch_body/
folder. You can install Stretch Body as "editable", and directly edit the source code to test changes.
In Python3, run python3 -m pip install -e .
For example, to test changes to stretch_body.robot.Robot
, run:
$ python3 -m pip uninstall hello-robot-stretch-body # ensure previous Stretch Body installations are removed
$ git clone https://github.com/hello-robot/stretch_body.git
$ cd stretch_body/body
$ python3 -m pip install -e .
Now, make desired edits to the stretch_body/body/stretch_body/robot.py file. Software using Stretch Body is now using the modified stretch_body.robot.Robot
class.
Deploying
Increment the version number and run the deploy.sh
script. Verify the new release is reflected on PyPI.
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 hello_robot_stretch_body-0.6.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8750c69865e509c9fea300b78405c6ad79298460e8b733af383d509015df7384 |
|
MD5 | 0937550eafcfca5b441e9c5914925e53 |
|
BLAKE2b-256 | 8fe37803a2516d349d78c34db93fd0c9d00d79395a89e0bf95bc281ad021600f |
Hashes for hello_robot_stretch_body-0.6.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0cf17fabcc2f0d1dca43b796980b1e880a076e53604c02161643b4b9bd3a7fa4 |
|
MD5 | 704d6e7c454cdcfaeed6b202a975804a |
|
BLAKE2b-256 | 83f34642477803e6150bd83e305a239374fd0938cd81075a064c56d621eef526 |