# martypy
Python library to communicate with Marty the Robot V1 and V2 by Robotical
[See the API Documentation](https://userguides.robotical.io/martyv2/documentation/python_function_reference)
To regenerate documentation:
- pip install -r dev-requirements.txt
- pydoc-markdown --server --open
- markdown_mmd api-documentation-edited.md -t dokuwiki -o docs-wiki.wiki
OR, automatically:
- run docgen.bat (or docgen.sh on Mac/Linux) from Python environment (will also create a docs-wiki.wiki file with the dokuwiki format)
### NOTE: Make sure `pandoc` is installed on your system to generate the dokuwiki documentation. You can install `pandoc` from [here](https://pandoc.org/installing.html)
## How to run example scripts
If you cloned the repository or downloaded the source code to try the [example scripts](examples),
you will need to make sure you have MartyPy installed before you can run the examples.
The easiest way to install MartyPy is with the `pip install martypy` script as explained in
[step 2 here](https://userguides.robotical.io/martyv2/userguides/python/setting_up_python_on_your_computer).
Once martypy is installed you can run each example using python.
The following (for the dance example) assumes you have connected your marty using the USB cable to a Windows computer
python example_dance.py USB
To run the sound example over WiFi when your Marty is connected on IP address 192.168.86.10, use:
python example_sound.py WiFi 192.168.0.10
If you would like to make modifications to the martypy library itself, it will be better to install
it from source using the command `pip install --editable /path/to/martypy/repo` (replacing
`/path/to/martypy/repo` as appropriate of course).
If you do not want to "`pip install`" the MartyPy library, you can add the following 4 lines at the
top (before any other code) of each script you want to run:
```python
import sys
import pathlib
cur_path = pathlib.Path(__file__).parent.resolve()
sys.path.append(str(cur_path.parent.resolve()))
```
Raw data
{
"_id": null,
"home_page": "http://github.com/robotical/martypy",
"name": "martypy",
"maintainer": "Robotical",
"docs_url": null,
"requires_python": null,
"maintainer_email": "hello@robotical.io",
"keywords": "ros, robot, marty, marty the robot, robotical",
"author": "Robotical",
"author_email": "hello@robotical.io",
"download_url": "https://files.pythonhosted.org/packages/72/f8/4d747e1a4f51ea0e435aaefd3efd44c21503bee349c8e05c19caa5d817c6/martypy-3.7.1.tar.gz",
"platform": null,
"description": "# martypy\n\nPython library to communicate with Marty the Robot V1 and V2 by Robotical\n\n[See the API Documentation](https://userguides.robotical.io/martyv2/documentation/python_function_reference)\n\nTo regenerate documentation:\n- pip install -r dev-requirements.txt\n- pydoc-markdown --server --open\n- markdown_mmd api-documentation-edited.md -t dokuwiki -o docs-wiki.wiki\nOR, automatically:\n- run docgen.bat (or docgen.sh on Mac/Linux) from Python environment (will also create a docs-wiki.wiki file with the dokuwiki format)\n\n### NOTE: Make sure `pandoc` is installed on your system to generate the dokuwiki documentation. You can install `pandoc` from [here](https://pandoc.org/installing.html)\n\n## How to run example scripts\n\nIf you cloned the repository or downloaded the source code to try the [example scripts](examples),\nyou will need to make sure you have MartyPy installed before you can run the examples.\n\nThe easiest way to install MartyPy is with the `pip install martypy` script as explained in\n[step 2 here](https://userguides.robotical.io/martyv2/userguides/python/setting_up_python_on_your_computer).\n\nOnce martypy is installed you can run each example using python.\nThe following (for the dance example) assumes you have connected your marty using the USB cable to a Windows computer\n\npython example_dance.py USB\n\nTo run the sound example over WiFi when your Marty is connected on IP address 192.168.86.10, use:\n\npython example_sound.py WiFi 192.168.0.10\n\nIf you would like to make modifications to the martypy library itself, it will be better to install\nit from source using the command `pip install --editable /path/to/martypy/repo` (replacing\n`/path/to/martypy/repo` as appropriate of course).\n\nIf you do not want to \"`pip install`\" the MartyPy library, you can add the following 4 lines at the\ntop (before any other code) of each script you want to run:\n\n```python\nimport sys\nimport pathlib\ncur_path = pathlib.Path(__file__).parent.resolve()\nsys.path.append(str(cur_path.parent.resolve()))\n```\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Python library for Marty the Robot V1 and V2",
"version": "3.7.1",
"project_urls": {
"Homepage": "http://github.com/robotical/martypy"
},
"split_keywords": [
"ros",
" robot",
" marty",
" marty the robot",
" robotical"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a4d55db39ffdf983f1871f29d1f4c60231c17b4b2aaa9840c8f1ab01c69c3ee8",
"md5": "4292dfe2ff7fa25dfeffece5c984b7c8",
"sha256": "3875ce0bfbaed01644f79a62e1419ffdb652ad219d9eda1bcdde9d7fb2c0837f"
},
"downloads": -1,
"filename": "martypy-3.7.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4292dfe2ff7fa25dfeffece5c984b7c8",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 80586,
"upload_time": "2024-12-16T15:35:52",
"upload_time_iso_8601": "2024-12-16T15:35:52.408491Z",
"url": "https://files.pythonhosted.org/packages/a4/d5/5db39ffdf983f1871f29d1f4c60231c17b4b2aaa9840c8f1ab01c69c3ee8/martypy-3.7.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "72f84d747e1a4f51ea0e435aaefd3efd44c21503bee349c8e05c19caa5d817c6",
"md5": "1611b9361220a81ab86d1d41d303efc4",
"sha256": "5a9a12e7471fe6d95264ac57b2e5ec9d7575ca0df4867d31de883675fc80ed24"
},
"downloads": -1,
"filename": "martypy-3.7.1.tar.gz",
"has_sig": false,
"md5_digest": "1611b9361220a81ab86d1d41d303efc4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 71803,
"upload_time": "2024-12-16T15:35:53",
"upload_time_iso_8601": "2024-12-16T15:35:53.826065Z",
"url": "https://files.pythonhosted.org/packages/72/f8/4d747e1a4f51ea0e435aaefd3efd44c21503bee349c8e05c19caa5d817c6/martypy-3.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 15:35:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "robotical",
"github_project": "martypy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "packaging",
"specs": [
[
"==",
"23.2"
]
]
},
{
"name": "pyserial",
"specs": [
[
"==",
"3.5"
]
]
},
{
"name": "Requests",
"specs": [
[
"==",
"2.31.0"
]
]
}
],
"lcname": "martypy"
}
JSON
