Skip to main content

CLI to interact with a Rubus API instance

Project description

# Rubus Client

This project contains a command-line interface program to interact with a deployed instance of [rubus-api](https://github.com/kjuvi/rubus-api).

## Commands overview

All the commands are grouped by functionalities. Here is a quick overview of how they are structured:

  • rubus
    • admin: these commands require administrative rights

    • authentication: Log in and manage your user

    • device: manage devices (turn on/off, deployment, …)

## Configuring the server

By default, Rubus will try to reach a running instance of Rubus API on localhost. You can configure another address with the RUBUS_API_URL environment variable.

## Authentication system

Excepted for the login, all the other commands require to be authenticated. Rubus API works with JWT and will return you one on a successful login. Since Rubus CLI is quite minimalist, there is no persistence, and you will have to take advantage of your shell capabilities.

In other words, Rubus CLI will display the JWT, and prompt you to save it as an environment variable (i.e. RUBUS_SESSION). The token is valid as long as your user has not reach his expiration time (if any).

You can either set it once and for good, for example in your .bashrc, or just set it in your current shell. Closing the shell will operate as a log out. However, keep in mind that it may be accessible through the bash_history, in case you are on a public computer.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rubus-cli-1.0.7.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rubus_cli-1.0.7-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file rubus-cli-1.0.7.tar.gz.

File metadata

  • Download URL: rubus-cli-1.0.7.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200508 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for rubus-cli-1.0.7.tar.gz
Algorithm Hash digest
SHA256 826bfaaec9229cd6aa8600e276a399fd00c03d33736ba287bfd72972f71c8fee
MD5 f56736c8b0a8a5b974919db4846c9c1d
BLAKE2b-256 0e68a6e1fccb86ac0cb8a18d6f538804ed4a24bae51adbd49740b65515ff714e

See more details on using hashes here.

File details

Details for the file rubus_cli-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: rubus_cli-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0.post20200508 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.7.7

File hashes

Hashes for rubus_cli-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 6e9c40c12febeed26e525213163c375b06bdddfdd208563b6a18a61da89efb69
MD5 05ad8073be64ca2dc0800d679ed308e0
BLAKE2b-256 84bf744010b839a076caeea43e50cef626a296455a70daa55dc3d5a9ad1b5dc0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page