Skip to main content

UbiOps Command Line Interface to interact with the UbiOps API.

Project description

ubiops-cli

Command Line Interface to interact with the UbiOps API (v2.1).

Includes:

  • Managing projects
  • Managing deployments
  • Deploying new deployment versions
  • Managing pipelines
  • Making requests

For more information, please visit https://ubiops.com/docs

Requirements.

Python 3.5+

Installation & Usage

pip install ubiops-cli

Then use the package like this:

ubiops --version

Troubleshooting

Command not found

If you successfully installed ubiops-cli but ubiops --version gives the following error: ubiops: command not found, you are likely missing the directory in you PATH variable where PIP installs scripts. You could solve this by adding the directory to your PATH variable. Please, visit https://packaging.python.org/tutorials/installing-packages/#installing-to-the-user-site for more information.

  • Linux and macOS: ~/.local/bin
  • Windows: something like C:\Users\Username\AppData\Roaming\Python36\Scripts

Getting Started

Please follow the installation procedure and then run the following:

Show the version of ubiops-cli:

ubiops --version

Signin & signout

Signin using your credentials:

ubiops signin

Signin using a service token:

ubiops signin --token

Show if you are authorized:

ubiops status

Signout:

ubiops signout

Managing resources

Show your projects:

ubiops projects list

Set a current project:

ubiops current_project set <MY_PROJECT_NAME>

Show your deployments:

ubiops deployments list

Documentation

Category Documentation reference
Authentication docs/authentication.md
Projects docs/projects.md
Config docs/config.md
Deployments docs/deployments.md
Deployment Versions docs/deployment_versions.md
Pipelines docs/pipelines.md
Blobs docs/blobs.md
Environment Variables docs/environment_variables.md
Logs docs/logs.md
Audit Events docs/audit_events.md
Schedules docs/schedules.md

Attribution

This software uses the library ignorance by Steve Cook - see license.

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

ubiops-cli-2.0.0.tar.gz (34.4 kB view hashes)

Uploaded Source

Built Distribution

ubiops_cli-2.0.0-py3-none-any.whl (55.0 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