hello-robot-stretch-body-tools


Namehello-robot-stretch-body-tools JSON
Version 0.7.7 PyPI version JSON
download
home_pagehttps://github.com/hello-robot/stretch_body
SummaryStretch Body Tools
upload_time2024-03-04 18:43:17
maintainer
docs_urlNone
authorHello Robot Inc
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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](https://docs.hello-robot.com/0.2/stretch-tutorials/stretch_body/tutorial_command_line_tools/).

Installing
----------

This package comes pre-installed on Stretch robots. To install or upgrade to a stable Stretch Body Command Line Tools for Python3, run:

```bash
$ 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:

```bash
$ python3 -m pip install --upgrade --pre hello-robot-stretch-body-tools
```

Please report feedback on the [Issue Tracker](https://github.com/hello-robot/stretch_body/issues) or the [Forum](https://forum.hello-robot.com/).

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:

```bash
$ stretch_robot_system_check.py
```

For more info on these tools, see the [tutorial](https://docs.hello-robot.com/0.2/stretch-tutorials/stretch_body/tutorial_command_line_tools/).

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

```bash
$ 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](./bin/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](https://pypi.org/project/hello-robot-stretch-body-tools/).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/hello-robot/stretch_body",
    "name": "hello-robot-stretch-body-tools",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Hello Robot Inc",
    "author_email": "support@hello-robot.com",
    "download_url": "https://files.pythonhosted.org/packages/df/30/722a2fb05384701cea19e2f5695993b7fc041a31b78df95145038f1802f9/hello_robot_stretch_body_tools-0.7.7.tar.gz",
    "platform": null,
    "description": "Stretch Body Command Line Tools\n===============================\n\nThis 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](https://docs.hello-robot.com/0.2/stretch-tutorials/stretch_body/tutorial_command_line_tools/).\n\nInstalling\n----------\n\nThis package comes pre-installed on Stretch robots. To install or upgrade to a stable Stretch Body Command Line Tools for Python3, run:\n\n```bash\n$ python3 -m pip install --upgrade hello-robot-stretch-body-tools\n```\n\nTo install or upgrade to a pre-release of the Command Line Tools for Python3, run:\n\n```bash\n$ python3 -m pip install --upgrade --pre hello-robot-stretch-body-tools\n```\n\nPlease report feedback on the [Issue Tracker](https://github.com/hello-robot/stretch_body/issues) or the [Forum](https://forum.hello-robot.com/).\n\nUsage\n-----\n\nAll 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:\n\n```bash\n$ stretch_robot_system_check.py\n```\n\nFor more info on these tools, see the [tutorial](https://docs.hello-robot.com/0.2/stretch-tutorials/stretch_body/tutorial_command_line_tools/).\n\nDeveloping\n----------\n\nThe 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.\n\nIn Python3, run `python3 -m pip install -e .`\n\nFor example, to test changes to the  `stretch_robot_home.py` script, run\n\n```bash\n$ python3 -m pip uninstall hello-robot-stretch-body-tools # ensure previous Stretch Body Tools installations are removed\n$ git clone https://github.com/hello-robot/stretch_body.git\n$ cd stretch_body/tools\n$ python3 -m pip install -e .\n```\n\nNow, make desired edits to the [stretch_robot_home.py](./bin/stretch_robot_home.py) file. Executing the script on the command-line will now run your modified version.\n\nDeploying\n---------\n\nIncrement the version number and run the `deploy.sh` script. Verify the new release is reflected [on PyPI](https://pypi.org/project/hello-robot-stretch-body-tools/).\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Stretch Body Tools",
    "version": "0.7.7",
    "project_urls": {
        "Homepage": "https://github.com/hello-robot/stretch_body"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9896cc4e8ae26babe50cbe45bea61a948c56452792a97f454e1312699ea42ab3",
                "md5": "3a3841d934675d5bc2a714986fd43b26",
                "sha256": "6ef80bb66fcd8427a8044227f4e38f66342e5665826692b3fbaa6d71c9a1744d"
            },
            "downloads": -1,
            "filename": "hello_robot_stretch_body_tools-0.7.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3a3841d934675d5bc2a714986fd43b26",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 70381,
            "upload_time": "2024-03-04T18:43:15",
            "upload_time_iso_8601": "2024-03-04T18:43:15.572569Z",
            "url": "https://files.pythonhosted.org/packages/98/96/cc4e8ae26babe50cbe45bea61a948c56452792a97f454e1312699ea42ab3/hello_robot_stretch_body_tools-0.7.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "df30722a2fb05384701cea19e2f5695993b7fc041a31b78df95145038f1802f9",
                "md5": "8e891843d882ef6e9b290a42a30ce3b6",
                "sha256": "7f6d353230dfc0b8a3c4c02f9252192b372197e834a748079b021841b5ca9d12"
            },
            "downloads": -1,
            "filename": "hello_robot_stretch_body_tools-0.7.7.tar.gz",
            "has_sig": false,
            "md5_digest": "8e891843d882ef6e9b290a42a30ce3b6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 50982,
            "upload_time": "2024-03-04T18:43:17",
            "upload_time_iso_8601": "2024-03-04T18:43:17.876613Z",
            "url": "https://files.pythonhosted.org/packages/df/30/722a2fb05384701cea19e2f5695993b7fc041a31b78df95145038f1802f9/hello_robot_stretch_body_tools-0.7.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-04 18:43:17",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "hello-robot",
    "github_project": "stretch_body",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "hello-robot-stretch-body-tools"
}
        
Elapsed time: 0.22764s