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 --upgrade --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.11.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e82762522c36d7e90934caad36aa3516b0dcc04a0933bd41c24cb181a7ab0d47 |
|
MD5 | 5bf7803bc0e47ff116fae70d20e64d75 |
|
BLAKE2b-256 | 02f7834d94ff4bffb02185f6e4a67a1390fc4596c772050b146c2a4d4abe796f |
Hashes for hello_robot_stretch_body-0.1.11.dev0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a81e92b8cfa537592e335d9cf89fa65c6df093d74cd3b0bf914f36e5edb97138 |
|
MD5 | 9d3f78e7fa7856c5792439f3f817f5cc |
|
BLAKE2b-256 | 4b7c37f92b5e2f3ffd0bf928f697df02c39fd42fb8309a02775e1292e0a66fdb |