Skip to main content

CLI tool to interact with InOrbit Cloud Platform

Project description

InOrbit CLI

Welcome to the InOrbit Command Line Interface.

Installing

https://pypi.org/project/inorbit-cli/

Make sure you deactivated the development virtual environment or you are using a different one with no inorbit python package installed.

pip install inorbit-cli

Usage

The CLI requires an API key for authenticating against InOrbit's platform. For obtaining it, please go to the InOrbit developer console.

$ export INORBIT_CLI_API_KEY="company_api_key" 
$ inorbit --help
Usage: inorbit [OPTIONS] COMMAND [ARGS]...

  InOrbit Command Line Interface tool

  The InOrbit CLI tool enable roboteers to interact with the InOrbit Cloud
  platform in order to manage robot configuration as code.

Options:
  --help  Show this message and exit.

Commands:
  describe
  get

Contributing

Publishing

To publish the InOrbit CLI package to the testing package index you'll need a token from test.pypi.org. Otherwise you'll need a token from https://pypi.org (The official python packages index) To get the token, register a new account and ask for an invite to the project.
Once you accept the invite, go to your profile and generate a new token for the "InOrbit CLI".
After that, to publish the package, first set the environment variable 'TWINE_PASSWORD' doing:

export TWINE_PASSWORD="your-token-from-pypi.org"
./publish.sh -p

NOTE: passing -p to the script means "production", the package will be published in the official package index, if you want to publish it in the test package index just run:

export TWINE_PASSWORD="your-token-from-test.pypi.org"
./publish.sh -t

See CONTRIBUTING.md

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

inorbit_cli-0.9.0.tar.gz (11.9 kB view hashes)

Uploaded Source

Built Distribution

inorbit_cli-0.9.0-py3-none-any.whl (14.5 kB view hashes)

Uploaded Python 3

Supported by

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