| Name | fourier-grx-client JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | None |
| Summary | Client library for Fourier GRx series robots |
| upload_time | 2024-09-11 06:59:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# fourier-grx-client
This is the client library for the Fourier GRX robot.
The correponding server library can be found [here](https://pypi.org/project/fourier-grx/0.1.1rc6/).
## Installation
> [!IMPORTANT]
> This software is highly unstable and subject to change at any time. Version 0.1.5 is only compatible with `fourier-grx` version `v0.1.1-rc.6`.
### On the robot
On the robot, install `fourier-grx==0.1.0rc6` following the instructions [here](https://github.com/FFTAI/Wiki-GRx-Deploy/tree/0.1.0rc6).
### On your local machine:
#### Install from pypi
Run:
```bash
pip install fourier-grx-client==0.1.5
```
#### Install from source
```bash
git clone https://github.com/FFTAI/fourier-grx-client.git
cd fourier-grx-client
pip install -e .
```
## Usage
First make sure you know the IP address of the robot server and the namespace it is running on.
Then you can create a client object like this:
```python
from fourier_grx_client import *
r = RobotClient(namespace="gr/my_awesome_robot", server_ip="192.168.6.6")
```
> [!TIP]
> For more information on the API, see the [API Reference](https://fftai.github.io/fourier-grx-client/latest/reference/api/).
## Development
1. Install the `pdm` package manager:
```bash
pip install pdm
```
2. use `pdm` to install the package and all development dependencies:
```bash
pdm install -v -d
```
Raw data
{
"_id": null,
"home_page": null,
"name": "fourier-grx-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Yuxiang Gao <yuxiang.gao@fftai.com>",
"download_url": "https://files.pythonhosted.org/packages/24/d9/b08046ba626fb89aad0738a5d1ae0c2eca0c44462443149cc31d738ce9cc/fourier_grx_client-0.1.5.tar.gz",
"platform": null,
"description": "# fourier-grx-client\n\nThis is the client library for the Fourier GRX robot.\nThe correponding server library can be found [here](https://pypi.org/project/fourier-grx/0.1.1rc6/).\n\n## Installation\n\n> [!IMPORTANT]\n> This software is highly unstable and subject to change at any time. Version 0.1.5 is only compatible with `fourier-grx` version `v0.1.1-rc.6`.\n\n### On the robot\n\nOn the robot, install `fourier-grx==0.1.0rc6` following the instructions [here](https://github.com/FFTAI/Wiki-GRx-Deploy/tree/0.1.0rc6).\n\n### On your local machine:\n\n#### Install from pypi\n\nRun:\n\n```bash\npip install fourier-grx-client==0.1.5\n```\n\n#### Install from source\n\n```bash\ngit clone https://github.com/FFTAI/fourier-grx-client.git\ncd fourier-grx-client\npip install -e .\n```\n\n## Usage\n\nFirst make sure you know the IP address of the robot server and the namespace it is running on.\nThen you can create a client object like this:\n\n```python\nfrom fourier_grx_client import *\n\nr = RobotClient(namespace=\"gr/my_awesome_robot\", server_ip=\"192.168.6.6\")\n```\n\n> [!TIP]\n> For more information on the API, see the [API Reference](https://fftai.github.io/fourier-grx-client/latest/reference/api/).\n\n\n## Development\n\n1. Install the `pdm` package manager:\n\n```bash\npip install pdm\n```\n\n2. use `pdm` to install the package and all development dependencies:\n\n```bash\npdm install -v -d\n```",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client library for Fourier GRx series robots",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7ed71fa25146579ec5f5eb546f758e09c8c567485f9c38ca480f0edcd1126da",
"md5": "9da312100b6dc21c4a33aa1c05d30748",
"sha256": "885a3dd9980ef54f1614696c3f2cf0920529e1d2b24c07e8e91333ef93fa9aa6"
},
"downloads": -1,
"filename": "fourier_grx_client-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9da312100b6dc21c4a33aa1c05d30748",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10439,
"upload_time": "2024-09-11T06:59:25",
"upload_time_iso_8601": "2024-09-11T06:59:25.871409Z",
"url": "https://files.pythonhosted.org/packages/a7/ed/71fa25146579ec5f5eb546f758e09c8c567485f9c38ca480f0edcd1126da/fourier_grx_client-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24d9b08046ba626fb89aad0738a5d1ae0c2eca0c44462443149cc31d738ce9cc",
"md5": "87a95a3d674a409c7a0f888d4f8b7693",
"sha256": "52c3ee11b307c25ed93d2c9d04ad538ce00d982f4e69d72e689d450fda4af437"
},
"downloads": -1,
"filename": "fourier_grx_client-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "87a95a3d674a409c7a0f888d4f8b7693",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9745,
"upload_time": "2024-09-11T06:59:27",
"upload_time_iso_8601": "2024-09-11T06:59:27.389368Z",
"url": "https://files.pythonhosted.org/packages/24/d9/b08046ba626fb89aad0738a5d1ae0c2eca0c44462443149cc31d738ce9cc/fourier_grx_client-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 06:59:27",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fourier-grx-client"
}
