# cloudshell-rest-api
[](https://github.com/QualiSystems/cloudshell-rest-api/actions?query=branch%3Amaster)
[](https://codecov.io/gh/QualiSystems/cloudshell-rest-api)
[](https://badge.fury.io/py/cloudshell-rest-api)
[](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
Raw data
{
"_id": null,
"home_page": "https://github.com/QualiSystems/cloudshell-rest-api",
"name": "cloudshell-rest-api",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "cloudshell quali sandbox cloud rest api",
"author": "Boris Modylevsky",
"author_email": "borismod@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d5/d5/47dd50b8338781a3e2aabc3d4941b4c160d51a0ab9bd75073944f5fb638e/cloudshell-rest-api-9.0.0.zip",
"platform": null,
"description": "# cloudshell-rest-api\n\n[](https://github.com/QualiSystems/cloudshell-rest-api/actions?query=branch%3Amaster)\n[](https://codecov.io/gh/QualiSystems/cloudshell-rest-api)\n[](https://badge.fury.io/py/cloudshell-rest-api)\n[](https://github.com/python/black)\n\n## Features\n\n* Add Shell - adds a new Shell Entity (supported from CloudShell 7.2)\n* Update Shell - updates an existing Shell Entity (supported from CloudShell 7.2)\n* Delete Shell - removes an existing Shell Entity (supported from CloudShell 9.2)\n* Get Shell - get Shell's information\n* Get Installed Standards - gets a list of standards and matching versions installed on CloudShell (supported from CloudShell 8.1)\n* Import Package - imports a package to CloudShell\n* Export Package - exports a package from CloudShell\n\n\n## Installation\n\n```bash\npip install cloudshell-rest-api\n```\n\n## Getting started\n\n```python\nfrom cloudshell.rest.api import PackagingRestApiClient\n# Loging to CloudShell\nclient = PackagingRestApiClient.login(\"HOST\", \"USERNAME\", \"PASSWORD\", \"DOMAIN\")\n# Or connect with a token\nclient = PackagingRestApiClient(\"HOST\", \"TOKEN\")\n# Add a new Shell to CloudShell\nclient.add_shell(\"SHELL_PATH.zip\")\n```\n\n## License\n\n* Free software: Apache Software License 2.0\n\n\n=======\nHistory\n=======\n\n9.0.0 (2023-05-04)\n--------------------\n\n* Added get_shell_as_model, get_installed_standards_as_model\n* Added the ability to connect with an existing token\n* Added progress bar for downloading/uploading files\n* Removed support of Python2\n\n8.2.2.0 (2019-01-08)\n--------------------\n\n* Added delete shell method to rest-api\n\n8.2.0.0 (2017-09-19)\n--------------------\n\n* newest addition to rest-api. please welcome get_shell - returns a requested shell information\n\n8.1.1.0 (2017-08-27)\n--------------------\n\n* remodeling update_shell to also accept shell name\n\n8.1.0.1 (2017-06-12)\n--------------------\n\n* Bug fix\n\n8.1.0.0 (2017-06-04)\n--------------------\n\n* Query installed standards on CloudShell server\n\n7.2.0.6 (2016-09-01)\n--------------------\n\n* First release of with Add Shell and Update Shell features\n\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Python client for the CloudShell REST API",
"version": "9.0.0",
"project_urls": {
"Homepage": "https://github.com/QualiSystems/cloudshell-rest-api"
},
"split_keywords": [
"cloudshell",
"quali",
"sandbox",
"cloud",
"rest",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2ab3444ed5e4bc42d68e061c7f3e7b520ab61a4bb3fb2f86d6bf53774a3d5117",
"md5": "d2a3563c711b9c37724d245c09b97d5e",
"sha256": "96da219fd2bae6dfc02f93d2918d1ff64b36bf4b14202eb45d4f1c00eb573d02"
},
"downloads": -1,
"filename": "cloudshell_rest_api-9.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2a3563c711b9c37724d245c09b97d5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 10702,
"upload_time": "2023-05-04T11:17:52",
"upload_time_iso_8601": "2023-05-04T11:17:52.438408Z",
"url": "https://files.pythonhosted.org/packages/2a/b3/444ed5e4bc42d68e061c7f3e7b520ab61a4bb3fb2f86d6bf53774a3d5117/cloudshell_rest_api-9.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d5d547dd50b8338781a3e2aabc3d4941b4c160d51a0ab9bd75073944f5fb638e",
"md5": "1ba86039ab3ca540ec0a082eed9a7ab4",
"sha256": "5e650ec423fcbc17adb85a0c5286989964a9f30edd610ee5d7ea70fbab691c59"
},
"downloads": -1,
"filename": "cloudshell-rest-api-9.0.0.zip",
"has_sig": false,
"md5_digest": "1ba86039ab3ca540ec0a082eed9a7ab4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 18083,
"upload_time": "2023-05-04T11:17:54",
"upload_time_iso_8601": "2023-05-04T11:17:54.314035Z",
"url": "https://files.pythonhosted.org/packages/d5/d5/47dd50b8338781a3e2aabc3d4941b4c160d51a0ab9bd75073944f5fb638e/cloudshell-rest-api-9.0.0.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-04 11:17:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "QualiSystems",
"github_project": "cloudshell-rest-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"test_requirements": [],
"tox": true,
"lcname": "cloudshell-rest-api"
}
JSON
