Stretch Body Command Line Tools
This package provides Python tools that work with the Hello Robot Stretch Body package. These tools perform common tasks when working with Stretch (e.g. homing and stowing), and serve as tutorial code for working on various parts of the robot. This package comes pre-installed on Stretch robots. A tutorial 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 Command Line Tools for Python3, run:
$ python3 -m pip install --upgrade hello-robot-stretch-body-tools
To install or upgrade to a pre-release of the Command Line Tools for Python3, run:
$ python3 -m pip install --upgrade --pre hello-robot-stretch-body-tools
Please report feedback on the Issue Tracker or the Forum.
Usage
All of the command-line tools reside within the bin/ folder. When this package is installed, they are accessible from anywhere as command-line tools. For example, to perform a robot system check, run:
$ stretch_robot_system_check.py
For more info on these tools, see the tutorial.
Developing
The source code for the command-line tools resides within the bin/ folder. You can install the tools package 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 the stretch_robot_home.py script, run
$ python3 -m pip uninstall hello-robot-stretch-body-tools # ensure previous Stretch Body Tools installations are removed
$ git clone https://github.com/hello-robot/stretch_body.git
$ cd stretch_body/tools
$ python3 -m pip install -e .
Now, make desired edits to the stretch_robot_home.py file. Executing the script on the command-line will now run your modified version.
Deploying
Increment the version number and run the deploy.sh script. Verify the new release is reflected on PyPI.
Metadata
Release files for hello-robot-stretch-body-tools 0.7.13
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hello_robot_stretch_body_tools-0.7.13.tar.gz | 51.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hello_robot_stretch_body_tools-0.7.13-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 122.3 kB
Release files / hello_robot_stretch_body_tools-0.7.13.tar.gz
| Download URL | hello_robot_stretch_body_tools-0.7.13.tar.gz |
|---|---|
| Size | 51.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9ce65bfc9a53444b7622c3479ab45c6aa9369618eb3bf102ef1172474d1873b7
|
|
BLAKE2b-256 checksum How to use checksums |
3b2a1a11e536ea18d1b7895ac5f09a4391817138570f2eab21d3351a6ce3233a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|
Release files / hello_robot_stretch_body_tools-0.7.13-py3-none-any.whl
| Download URL | hello_robot_stretch_body_tools-0.7.13-py3-none-any.whl |
|---|---|
| Size | 71.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f12bd4ee40e48c11e68392e7fd91c3a752e87d44d864d1adb3998b30c0166e75
|
|
BLAKE2b-256 checksum How to use checksums |
8b707a065e1146532fc9937d96baa1a96509fcba39307bf558d3600fd01f1590
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.12
|