============
rebotics_sdk
============
Rebotics SDK for communicating with Rebotics Services, API CLI client.
Features
--------
* Communication between Rebotics Services through provider client classes
* Two django applications for external communications through web-hooks
* CLI clients for Rebotics Services
Prerequisites
-------------
You need to have Python 3.7+ installed in your system for current system user.
Installation
------------
Linux & MacOS
~~~~~~~~~~~~~
Can be installed with pip:
.. code:: sh
pip3 install --user --upgrade rebotics_sdk
You should have directory ~/.local/bin/ in your PATH variable in
~/.bashrc or ~/.bash_profile.
Windows
~~~~~~~
Is installed without –user flag:
.. code:: sh
pip install --upgrade rebotics_sdk
Open environment variable settings and find PATH variable.
After installation rebotics-scripts should be located inside python3
directory.
Append the following path ``%APPDATA%\Local\Python<version>\bin\`` to
PATH variable, then log out from your system or restart your PC.
CLI Installation
~~~~~~~~~~~~~~~~
To run the commands in shell:
.. code:: sh
pip install --upgrade --quiet --no-input rebotics_sdk[shell]
Usage
-----
After successful installation the CLI for following services should be
accessible:
- admin
- dataset
- retailer
- rebm
- rebotics
- fvm
- hawkeye
- hawkeye_camera
The “role” could be configured for these services except rebotics and hawkeye_camera.
Retailer setup
~~~~~~~~~~~~~~
For setup you need to configure role to access retailer instance with
specifying retailer server:
.. code:: sh
retailer -r alpha configure --help
This command will prompt you to set retailer host, your username and
password.
For role you can specify anything for your own convenience.
Retailer CLI client
~~~~~~~~~~~~~~~~~~~
Usage:
.. code:: sh
retailer [OPTIONS] COMMAND [ARGS]...
Options:
::
-f, --format [table|id|json]
-v, --verbose Enables verbose mode
-c, --config PATH Specify what config.json to use
-r, --role TEXT Key to specify what retailer to use
[required]
--api-verbosity INT Display request detail
--version Show the version and exit.
--help Show this message and exit.
*Note: The same CLI structure could be used for other services. Check
the documentation on available commands at*\ `Confluence
page <https://retech.atlassian.net/wiki/spaces/REB3/pages/2703097931/Rebotics+SDK+CLI+client>`__\ *.*
Hawkeye Camera CLI client
~~~~~~~~~~~~~~~~~~~~~~~~~
Admin CLI tool to communicate with Public Hawkeye API for cameras
without authorization does not require to configure role in
rebotics_sdk. Instead, it accepts the target server url.
Example usage:
.. code:: sh
hawkeye_camera -h https://hawkeye.rebotics.net create-capture "path_to_image.jpg" -c "camera_token"
Credits
-------
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.1.0 (2019-05-22)
------------------
* First release on PyPI.
Raw data
{
"_id": null,
"home_page": "http://retechlabs.com/rebotics/",
"name": "rebotics-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "rebotics_sdk",
"author": "Malik Sulaimanov",
"author_email": "malik@retechlabs.com",
"download_url": "https://files.pythonhosted.org/packages/a0/b6/968b7398b1f3e2ea54551f36c3bcd51257966dcf98d8b794c836c9bb1084/rebotics_sdk-0.30.4.tar.gz",
"platform": null,
"description": "============\nrebotics_sdk\n============\n\nRebotics SDK for communicating with Rebotics Services, API CLI client.\n\nFeatures\n--------\n\n* Communication between Rebotics Services through provider client classes\n* Two django applications for external communications through web-hooks\n* CLI clients for Rebotics Services\n\nPrerequisites\n-------------\n\nYou need to have Python 3.7+ installed in your system for current system user.\n\nInstallation\n------------\n\nLinux & MacOS\n~~~~~~~~~~~~~\n\nCan be installed with pip:\n\n.. code:: sh\n\n pip3 install --user --upgrade rebotics_sdk\n\nYou should have directory ~/.local/bin/ in your PATH variable in\n~/.bashrc or ~/.bash_profile.\n\nWindows\n~~~~~~~\n\nIs installed without \u2013user flag:\n\n.. code:: sh\n\n pip install --upgrade rebotics_sdk\n\nOpen environment variable settings and find PATH variable.\n\nAfter installation rebotics-scripts should be located inside python3\ndirectory.\n\nAppend the following path ``%APPDATA%\\Local\\Python<version>\\bin\\`` to\nPATH variable, then log out from your system or restart your PC.\n\nCLI Installation\n~~~~~~~~~~~~~~~~\n\nTo run the commands in shell:\n\n.. code:: sh\n\n pip install --upgrade --quiet --no-input rebotics_sdk[shell]\n\nUsage\n-----\n\nAfter successful installation the CLI for following services should be\naccessible:\n\n- admin\n- dataset\n- retailer\n- rebm\n- rebotics\n- fvm\n- hawkeye\n- hawkeye_camera\n\nThe \u201crole\u201d could be configured for these services except rebotics and hawkeye_camera.\n\nRetailer setup\n~~~~~~~~~~~~~~\n\nFor setup you need to configure role to access retailer instance with\nspecifying retailer server:\n\n.. code:: sh\n\n retailer -r alpha configure --help\n\nThis command will prompt you to set retailer host, your username and\npassword.\n\nFor role you can specify anything for your own convenience.\n\nRetailer CLI client\n~~~~~~~~~~~~~~~~~~~\n\nUsage:\n\n.. code:: sh\n\n retailer [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n\n::\n\n -f, --format [table|id|json]\n\n -v, --verbose Enables verbose mode\n\n -c, --config PATH Specify what config.json to use\n\n -r, --role TEXT Key to specify what retailer to use\n\n [required]\n\n --api-verbosity INT Display request detail\n\n --version Show the version and exit.\n\n --help Show this message and exit.\n\n*Note: The same CLI structure could be used for other services. Check\nthe documentation on available commands at*\\ `Confluence\npage <https://retech.atlassian.net/wiki/spaces/REB3/pages/2703097931/Rebotics+SDK+CLI+client>`__\\ *.*\n\nHawkeye Camera CLI client\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nAdmin CLI tool to communicate with Public Hawkeye API for cameras\nwithout authorization does not require to configure role in\nrebotics_sdk. Instead, it accepts the target server url.\n\nExample usage:\n\n.. code:: sh\n\n hawkeye_camera -h https://hawkeye.rebotics.net create-capture \"path_to_image.jpg\" -c \"camera_token\"\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\n=======\nHistory\n=======\n\n0.1.0 (2019-05-22)\n------------------\n\n* First release on PyPI.\n",
"bugtrack_url": null,
"license": null,
"summary": "Rebotics SDK for communicating with Rebotic Services, API CLI client.",
"version": "0.30.4",
"project_urls": {
"Homepage": "http://retechlabs.com/rebotics/"
},
"split_keywords": [
"rebotics_sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e1be970c9bbf2cb715a09b9781792858ac68966b5bf15b6f10e55dc0df3cdc14",
"md5": "99685832f0d4449fce2e47a43f937c42",
"sha256": "c5e9394e54876a1d596679320f03654d73f9dc31140f6961fee53b561543a41a"
},
"downloads": -1,
"filename": "rebotics_sdk-0.30.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "99685832f0d4449fce2e47a43f937c42",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 104897,
"upload_time": "2024-12-18T13:27:07",
"upload_time_iso_8601": "2024-12-18T13:27:07.925285Z",
"url": "https://files.pythonhosted.org/packages/e1/be/970c9bbf2cb715a09b9781792858ac68966b5bf15b6f10e55dc0df3cdc14/rebotics_sdk-0.30.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a0b6968b7398b1f3e2ea54551f36c3bcd51257966dcf98d8b794c836c9bb1084",
"md5": "40431fbeab3db597ea8bcca3e98ce770",
"sha256": "adb53419f2be92e3e52be5253561e9b46aa50a73943754a57a3f34a6f6485c60"
},
"downloads": -1,
"filename": "rebotics_sdk-0.30.4.tar.gz",
"has_sig": false,
"md5_digest": "40431fbeab3db597ea8bcca3e98ce770",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21482034,
"upload_time": "2024-12-18T13:27:10",
"upload_time_iso_8601": "2024-12-18T13:27:10.830595Z",
"url": "https://files.pythonhosted.org/packages/a0/b6/968b7398b1f3e2ea54551f36c3bcd51257966dcf98d8b794c836c9bb1084/rebotics_sdk-0.30.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 13:27:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rebotics-sdk"
}
JSON