Skip to main content

Python client for the CloudShell REST API

Project description

# cloudshell-rest-api

[![Build status](https://github.com/QualiSystems/cloudshell-rest-api/workflows/CI/badge.svg?branch=master)](https://github.com/QualiSystems/cloudshell-rest-api/actions?query=branch%3Amaster) [![codecov](https://codecov.io/gh/QualiSystems/cloudshell-rest-api/branch/master/graph/badge.svg)](https://codecov.io/gh/QualiSystems/cloudshell-rest-api) [![PyPI version](https://badge.fury.io/py/cloudshell-rest-api.svg)](https://badge.fury.io/py/cloudshell-rest-api) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)

## Features

  • Add Shell - adds a new Shell Entity (supported from CloudShell 7.2)

  • Update Shell - updates an existing Shell Entity (supported from CloudShell 7.2)

  • Delete Shell - removes an existing Shell Entity (supported from CloudShell 9.2)

  • Get Shell - get Shell’s information

  • Get Installed Standards - gets a list of standards and matching versions installed on CloudShell (supported from CloudShell 8.1)

  • Import Package - imports a package to CloudShell

  • Export Package - exports a package from CloudShell

## Installation

`bash pip install cloudshell-rest-api `

## Getting started

`python from cloudshell.rest.api import PackagingRestApiClient # Loging to CloudShell client = PackagingRestApiClient.login("HOST", "USERNAME", "PASSWORD", "DOMAIN") # Or connect with a token client = PackagingRestApiClient("HOST", "TOKEN") # Add a new Shell to CloudShell client.add_shell("SHELL_PATH.zip") `

## License

  • Free software: Apache Software License 2.0

History

9.0.0 (2023-05-04)

  • Added get_shell_as_model, get_installed_standards_as_model

  • Added the ability to connect with an existing token

  • Added progress bar for downloading/uploading files

  • Removed support of Python2

8.2.2.0 (2019-01-08)

  • Added delete shell method to rest-api

8.2.0.0 (2017-09-19)

  • newest addition to rest-api. please welcome get_shell - returns a requested shell information

8.1.1.0 (2017-08-27)

  • remodeling update_shell to also accept shell name

8.1.0.1 (2017-06-12)

  • Bug fix

8.1.0.0 (2017-06-04)

  • Query installed standards on CloudShell server

7.2.0.6 (2016-09-01)

  • First release of with Add Shell and Update Shell features

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

cloudshell-rest-api-9.0.0.zip (18.1 kB view details)

Uploaded Source

Built Distribution

cloudshell_rest_api-9.0.0-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file cloudshell-rest-api-9.0.0.zip.

File metadata

  • Download URL: cloudshell-rest-api-9.0.0.zip
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for cloudshell-rest-api-9.0.0.zip
Algorithm Hash digest
SHA256 5e650ec423fcbc17adb85a0c5286989964a9f30edd610ee5d7ea70fbab691c59
MD5 1ba86039ab3ca540ec0a082eed9a7ab4
BLAKE2b-256 d5d547dd50b8338781a3e2aabc3d4941b4c160d51a0ab9bd75073944f5fb638e

See more details on using hashes here.

File details

Details for the file cloudshell_rest_api-9.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cloudshell_rest_api-9.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 96da219fd2bae6dfc02f93d2918d1ff64b36bf4b14202eb45d4f1c00eb573d02
MD5 d2a3563c711b9c37724d245c09b97d5e
BLAKE2b-256 2ab3444ed5e4bc42d68e061c7f3e7b520ab61a4bb3fb2f86d6bf53774a3d5117

See more details on using hashes here.

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