rebotics-sdk 0.31.1

API client and CLI tools for working with SymphonyAI Store Intelligence platform

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:

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:

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:

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:

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:

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.

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:

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.

History

0.1.0 (2019-05-22)

• First release on PyPI.