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.28.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc9a91c3b9e41bb2cad3cf3c37b6b40d4418cea702a2bbfa78f21770b2a0a159 |
|
MD5 | cc9def64fd1bd089bbc82417be095042 |
|
BLAKE2b-256 | 73bfb19b1952a190adc7ffb40e05fb1279d70327abc50c4764e6122f091b9453 |
Hashes for hello_robot_stretch_body-0.4.28-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 328e6e8429c7abdb9cbbf05da71f9051fe54ccb75843005d649d7e60fc157ab1 |
|
MD5 | e7599cdbf7e6f4ec76b02e8a515de1b6 |
|
BLAKE2b-256 | 8c818ceb2cd5dde328e321a5e26992f5fd9c466ee24ab487a68467f3f393a5c7 |