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.4.24.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb716422d34ef98c2746a2570e6b775377c1232a678d4df97f482f20645eb30c |
|
MD5 | 103ce1c208b6057ce75cebd16e6086d8 |
|
BLAKE2b-256 | 03f4bfe3f09242b72425138350124180269cbd78a144012724c19e2fce041e4a |
Hashes for hello_robot_stretch_body-0.4.24-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c60d18665248da0d18acb9c8a72b65b1c06618a02f13cf9abbc608e8077a56b |
|
MD5 | 936379931e60dce1f9fc216b0d866e04 |
|
BLAKE2b-256 | 5c9694c9a24cfe0b41168430c95ec7353ba72de6d891db4f7873adc416f03a3e |