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.5.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e4c2477b984b43b0c4f266c89df7a664b7bdd7752c25039964fd356295a9fec |
|
MD5 | 828f09c3f76f069f668e302cc5351e74 |
|
BLAKE2b-256 | ea1582831283832af2c9d3bc591a629afc150f0d128c63887e6f9d5d8e15c428 |
Hashes for hello_robot_stretch_body-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80957fee41a78bf31adb18e35b2d67eca61353503307a39510f5d9380e8a0f73 |
|
MD5 | 174d24a059821eef23458bc5f3581bf2 |
|
BLAKE2b-256 | 73333e5b5b114b02ced7eca641a409070f840ce2aeed76586f96e2e1d0c6330d |