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, …)

## 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.5.tar.gz (4.2 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.5-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rubus-cli-1.0.5.tar.gz
  • Upload date:
  • Size: 4.2 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.5.tar.gz
Algorithm Hash digest
SHA256 4286bb26a507c69dd242238eb3d69623028a9d3ab09d1e5d6cdd788d53e4eec4
MD5 3fe307e14a4781aa833179500434b777
BLAKE2b-256 252445d4fa7ca79911ee730bf7a8a608e787caea4e68ebffc33b35a583e6e744

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rubus_cli-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 6.7 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8d8741c0861479d3e775eb54a8aea763364e8506d359e34c527e04263a3a286e
MD5 f92d97f1d4ebbbf171ae25cddcda5724
BLAKE2b-256 4d93ccaa1c892f4ff988ffe500bbf263cc455fecb41f26dba58018c33d91c551

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