Skip to content

Commit c69d05c

Browse files
committed
update README
1 parent ba16b23 commit c69d05c

File tree

3 files changed

+48
-1
lines changed

3 files changed

+48
-1
lines changed

HISTORY.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22
History
33
=======
44

5+
9.0.0 (2023-05-04)
6+
--------------------
7+
8+
* Added get_shell_as_model, get_installed_standards_as_model
9+
* Added the ability to connect with an existing token
10+
* Added progress bar for downloading/uploading files
11+
* Removed support of Python2
12+
513
8.2.2.0 (2019-01-08)
614
--------------------
715

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# cloudshell-rest-api
2+
3+
[![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)
4+
[![codecov](https://codecov.io/gh/QualiSystems/cloudshell-rest-api/branch/master/graph/badge.svg)](https://codecov.io/gh/QualiSystems/cloudshell-rest-api)
5+
[![PyPI version](https://badge.fury.io/py/cloudshell-rest-api.svg)](https://badge.fury.io/py/cloudshell-rest-api)
6+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
7+
8+
## Features
9+
10+
* Add Shell - adds a new Shell Entity (supported from CloudShell 7.2)
11+
* Update Shell - updates an existing Shell Entity (supported from CloudShell 7.2)
12+
* Delete Shell - removes an existing Shell Entity (supported from CloudShell 9.2)
13+
* Get Shell - get Shell's information
14+
* Get Installed Standards - gets a list of standards and matching versions installed on CloudShell (supported from CloudShell 8.1)
15+
* Import Package - imports a package to CloudShell
16+
* Export Package - exports a package from CloudShell
17+
18+
19+
## Installation
20+
21+
```bash
22+
pip install cloudshell-rest-api
23+
```
24+
25+
## Getting started
26+
27+
```python
28+
from cloudshell.rest.api import PackagingRestApiClient
29+
# Loging to CloudShell
30+
client = PackagingRestApiClient.login("HOST", "USERNAME", "PASSWORD", "DOMAIN")
31+
# Or connect with a token
32+
client = PackagingRestApiClient("HOST", "TOKEN")
33+
# Add a new Shell to CloudShell
34+
client.add_shell("SHELL_PATH.zip")
35+
```
36+
37+
## License
38+
39+
* Free software: Apache Software License 2.0

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ def get_file_content(file_name):
66
return f.read()
77

88

9-
readme = get_file_content("README.rst")
9+
readme = get_file_content("README.md")
1010
history = get_file_content("HISTORY.rst")
1111
version = get_file_content("version.txt").strip()
1212

0 commit comments

Comments
 (0)