Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

ocsw-cli - Octave Cloud command-line tool

License: MIT

This is not an official implementation of the command line interface (CLI) for the Octave Cloud REST API.

The ocsw makes calls to Octave Cloud Infrastructure APIs to provide the functionality implemented for the various services. These are REST APIs that use HTTPS requests and responses.

API Reference

This package includes a client implementing the api described in https://rest.octave.dev/

Requirements

To install and use the CLI, you must have:

  • An Octave Cloud Infrastructure account. A user created in that account, in a group with a policy that grants the desired permissions. This account user can be that calls the API.

  • System use token-based authentication. You can get the API token for your user by logging into Octave Cloud, On the lower left side of the main page, you will see Master Token option. Click here and a pop up will display your token along with the user you will use with the Octave Cloud APIs.

Installation

As per usual:

pip install ocsw

Environment variables

VARIABLE Description
OCTAVE_CLOUD_API_URL default: https://octave-api.sierrawireless.io/v5.0
End point octave cloud
OCTAVE_CLOUD_TOKEN Master Token
OCTAVE_CLOUD_USER Your user id
OCTAVE_CLOUD_COMPANY Identifier of one of the company

Release files for ocsw 0.1.0.dev0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ocsw 0.1.0.dev0
File Size Uploaded
ocsw-0.1.0.dev0.tar.gz 22.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ocsw 0.1.0.dev0
File Interpreter ABI Platform
ocsw-0.1.0.dev0-py3-none-any.whl Python 3 none any Details

Total release size: 75.6 kB

Release files / ocsw-0.1.0.dev0.tar.gz

Download URL ocsw-0.1.0.dev0.tar.gz
Size 22.7 kB
Tags Source
SHA-256 checksum
How to use checksums
07165d30689f7ba247081f31c132baadf05ebb180514d1abd68e5e26c9eb3469
BLAKE2b-256 checksum
How to use checksums
8ae3114967c76ef0be611cbad356beceb54a2a427221ce09c501edeb93f29238
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.9

Release files / ocsw-0.1.0.dev0-py3-none-any.whl

Download URL ocsw-0.1.0.dev0-py3-none-any.whl
Size 52.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8aafbde37eea785f0e42ef0f0ad8d6f576ad5f1cae1aa88324cdc3cb837ccb12
BLAKE2b-256 checksum
How to use checksums
0df0d3093194c270df39f0311d9891e243eafa0b722404a8c35227719b47238f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.9
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page