Stretch RE1 low level Python API
Project description
The stretch_body package provides a low level Python API to the Hello Robot Stretch RE1 hardware.
Installing
To install stable Stretch Body for Python2, run:
`bash $ python -m pip install --upgrade hello-robot-stretch-body `
To install a pre-release of Stretch Body for Python2, run:
`bash $ python -m pip install --pre hello-robot-stretch-body `
Please report feedback on the [Issue Tracker](https://github.com/hello-robot/stretch_body/issues) or the [Forum](https://forum.hello-robot.com/).
For Python3, substitute python with python3.
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 Python2, run python -m unittest test.test_<suite-name>. For Python3, substitute python with python3.
For example, to run the stretch_body.robot.Robot functional tests, run
`bash $ git clone https://github.com/hello-robot/stretch_body.git $ cd stretch_body/body $ python -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 Python2, run python -m pip install -e . For Python3, substitute python with python3.
For example, to test changes to stretch_body.robot.Robot, run
`bash $ git clone https://github.com/hello-robot/stretch_body.git $ cd stretch_body/body $ python -m pip install -e . `
Now, make desired edits to the [stretch_body/body/stretch_body/robot.py](./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.
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.1.4.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d58267045e306e5f00a97e82229eb418089cb399f28b399eb52bc0c31309a683 |
|
MD5 | 31d4ae60ccc61794e4e4001b744a305a |
|
BLAKE2b-256 | 925b44588567e1851510428a0cf86031ba92746fff09a3b076c28fe4ce5854e3 |
Hashes for hello_robot_stretch_body-0.1.4.dev0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e812ea2725e7790706edefb8f5ae0d1177bbeb4b9265cd3e1ff51fa559bd92b8 |
|
MD5 | 57badfb79256cd930b7c41154ddf138f |
|
BLAKE2b-256 | bc8a3d817998b848d40608a21f536afda9f209196cfee26fea8dfa6a559d3314 |