cloudshell-rest-api 8.2.3.2__tar.gz → 9.0.2__tar.gz

{cloudshell-rest-api-8.2.3.2 → cloudshell_rest_api-9.0.2}/HISTORY.rst

@@ -2,6 +2,14 @@
 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)
 --------------------
 

cloudshell_rest_api-9.0.2/MANIFEST.in

@@ -0,0 +1,8 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include HISTORY.rst
+include LICENSE
+include README.md
+include requirements.txt
+include test_requirements.txt
+include version.txt

cloudshell_rest_api-9.0.2/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: cloudshell-rest-api
+Version: 9.0.2
+Summary: Python client for the CloudShell REST API
+Home-page: https://github.com/QualiSystems/cloudshell-rest-api
+Author: Boris Modylevsky
+Author-email: borismod@gmail.com
+License: Apache Software License 2.0
+Keywords: cloudshell quali sandbox cloud rest api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.9
+Requires-Python: ~=3.7
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: requests<3,>=2.23
+Requires-Dist: attrs<24,>=21
+Requires-Dist: typing-extensions>=4.4
+Requires-Dist: alive_progress~=3.0
+Requires-Dist: requests_toolbelt~=1.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 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 8.0)
+* Update Shell - updates an existing Shell Entity (supported from CloudShell 8.0)
+* 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
+

cloudshell_rest_api-9.0.2/README.md

@@ -0,0 +1,39 @@
+# 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 8.0)
+* Update Shell - updates an existing Shell Entity (supported from CloudShell 8.0)
+* 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

cloudshell_rest_api-9.0.2/cloudshell/__init__.py

@@ -0,0 +1,3 @@
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)

cloudshell_rest_api-9.0.2/cloudshell/rest/__init__.py

@@ -0,0 +1,3 @@
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)

cloudshell_rest_api-9.0.2/cloudshell/rest/api.py

@@ -0,0 +1,207 @@
+from __future__ import annotations
+
+import os
+from collections.abc import Generator
+from pathlib import Path
+from typing import BinaryIO
+from urllib.parse import urljoin
+
+import requests
+from attrs import define, field
+from typing_extensions import Self
+
+from cloudshell.rest.exceptions import (
+    FeatureUnavailable,
+    LoginFailedError,
+    PackagingRestApiError,
+    ShellNotFound,
+)
+from cloudshell.rest.models import ShellInfo, StandardInfo
+from cloudshell.rest.progress_bar import iter_resp_with_pb, upload_with_pb
+
+DEFAULT_API_TIMEOUT = 15
+
+
+@define
+class PackagingRestApiClient:
+    host: str
+    _token: str = field(repr=False)
+    port: int = 9000
+    _show_progress: bool = field(default=False, repr=False)
+    _api_timeout: int = field(default=DEFAULT_API_TIMEOUT, repr=False)
+    _api_url: str = field(init=False)
+    _headers: dict[str, str] = field(init=False)
+
+    def __attrs_post_init__(self):
+        self._api_url = _get_api_url(self.host, self.port)
+        self._headers = {"Authorization": f"Basic {self._token}"}
+
+    @classmethod
+    def login(
+        cls,
+        host: str,
+        username: str,
+        password: str,
+        domain: str = "Global",
+        port: int = 9000,
+        show_progress: bool = False,
+        api_timeout: int = DEFAULT_API_TIMEOUT,
+    ) -> Self:
+        url = urljoin(_get_api_url(host, port), "Auth/Login")
+        req_data = {
+            "username": username,
+            "password": password,
+            "domain": domain,
+        }
+        resp = requests.put(url, data=req_data, timeout=api_timeout)
+        if resp.status_code == 401:
+            raise LoginFailedError(resp.text)
+        elif resp.status_code != 200:
+            raise PackagingRestApiError(resp.text)
+        token = resp.text.strip("'\"")
+        return cls(
+            host, token, port, show_progress=show_progress, api_timeout=api_timeout
+        )
+
+    def add_shell_from_buffer(self, file_obj: BinaryIO | bytes) -> None:
+        """Add a new Shell from the buffer or binary."""
+        url = urljoin(self._api_url, "Shells")
+        req_data = {"files": ("file", file_obj)}
+        headers = self._headers.copy()
+
+        with upload_with_pb(req_data, headers, show=self._show_progress) as new_data:
+            resp = requests.post(
+                url, data=new_data, headers=headers, timeout=self._api_timeout
+            )
+
+        if resp.status_code != 201:
+            msg = f"Can't add shell, response: {resp.text}"
+            raise PackagingRestApiError(msg)
+
+    def add_shell(self, shell_path: str | Path) -> None:
+        """Adds a new Shell Entity to CloudShell.
+
+        If the shell exists, exception will be thrown
+        """
+        with open(shell_path, "rb") as f:
+            self.add_shell_from_buffer(f)
+
+    def update_shell_from_buffer(
+        self, file_obj: BinaryIO | bytes, shell_name: str
+    ) -> None:
+        """Updates an existing Shell from the buffer or binary."""
+        url = urljoin(self._api_url, f"Shells/{shell_name}")
+        req_data = {"files": ("file", file_obj)}
+        headers = self._headers.copy()
+
+        with upload_with_pb(req_data, headers, show=self._show_progress) as new_data:
+            resp = requests.put(
+                url, data=new_data, headers=headers, timeout=self._api_timeout
+            )
+
+        if resp.status_code == 404:
+            raise ShellNotFound()
+        elif resp.status_code != 200:
+            msg = f"Can't update shell, response: {resp.text}"
+            raise PackagingRestApiError(msg)
+
+    def update_shell(
+        self, shell_path: str | Path, shell_name: str | None = None
+    ) -> None:
+        """Updates an existing Shell Entity in CloudShell."""
+        shell_name = shell_name or os.path.basename(shell_path).rsplit(".", 1)[0]
+        with open(shell_path, "rb") as f:
+            self.update_shell_from_buffer(f, shell_name)
+
+    def get_installed_standards(self) -> list[dict]:
+        """Gets all standards installed on CloudShell."""
+        url = urljoin(self._api_url, "Standards")
+        resp = requests.get(url, headers=self._headers, timeout=self._api_timeout)
+        if resp.status_code == 404:
+            raise FeatureUnavailable()
+        elif resp.status_code != 200:
+            raise PackagingRestApiError(resp.text)
+        return resp.json()
+
+    def get_installed_standards_as_models(self) -> list[StandardInfo]:
+        """Get all standards installed on CloudShell as models."""
+        return [StandardInfo.from_dict(s) for s in self.get_installed_standards()]
+
+    def get_shell(self, shell_name: str) -> dict:
+        """Get a Shell's information."""
+        url = urljoin(self._api_url, f"Shells/{shell_name}")
+        resp = requests.get(url, headers=self._headers, timeout=self._api_timeout)
+        if resp.status_code == 404:
+            raise FeatureUnavailable()
+        elif resp.status_code == 400:
+            raise ShellNotFound()
+        elif resp.status_code != 200:
+            raise PackagingRestApiError(resp.text)
+        return resp.json()
+
+    def get_shell_as_model(self, shell_name: str) -> ShellInfo:
+        """Get a Shell's information as model."""
+        return ShellInfo.from_dict(self.get_shell(shell_name))
+
+    def delete_shell(self, shell_name: str) -> None:
+        """Delete a Shell from the CloudShell."""
+        url = urljoin(self._api_url, f"Shells/{shell_name}")
+        resp = requests.delete(url, headers=self._headers, timeout=self._api_timeout)
+        if resp.status_code == 404:
+            raise FeatureUnavailable()
+        elif resp.status_code == 400:
+            raise ShellNotFound()
+        elif resp.status_code != 200:
+            raise PackagingRestApiError(resp.text)
+
+    def export_package(self, topologies: list[str]) -> Generator[bytes, None, None]:
+        """Export a package with the topologies from the CloudShell."""
+        url = urljoin(self._api_url, "Package/ExportPackage")
+        req_data = {"TopologyNames": topologies}
+        resp = requests.post(
+            url,
+            headers=self._headers,
+            json=req_data,
+            stream=True,
+            timeout=self._api_timeout,
+        )
+
+        if resp.status_code == 404:
+            raise FeatureUnavailable()
+        elif resp.status_code != 200:
+            raise PackagingRestApiError(resp.text)
+
+        yield from iter_resp_with_pb(resp, show=self._show_progress)
+
+    def export_package_to_file(
+        self, topologies: list[str], file_path: str | Path
+    ) -> None:
+        """Export a package with the topologies and save it to the file."""
+        with open(file_path, "wb") as f:
+            for data in self.export_package(topologies):
+                f.write(data)
+
+    def import_package_from_buffer(self, file_obj: BinaryIO | bytes) -> None:
+        """Import the package from buffer to the CloudShell."""
+        url = urljoin(self._api_url, "Package/ImportPackage")
+        req_data = {"files": ("file", file_obj)}
+        headers = self._headers.copy()
+
+        with upload_with_pb(req_data, headers, show=self._show_progress) as new_data:
+            resp = requests.post(
+                url, data=new_data, headers=headers, timeout=self._api_timeout
+            )
+
+        if resp.status_code == 404:
+            raise FeatureUnavailable()
+        elif resp.status_code != 200:
+            raise PackagingRestApiError(resp.text)
+
+    def import_package(self, package_path: str | Path) -> None:
+        """Import the package from the file to the CloudShell."""
+        with open(package_path, "rb") as f:
+            self.import_package_from_buffer(f)
+
+
+def _get_api_url(host: str, port: int) -> str:
+    return f"http://{host}:{port}/API/"

cloudshell_rest_api-9.0.2/cloudshell/rest/exceptions.py

@@ -0,0 +1,14 @@
+class PackagingRestApiError(Exception):
+    """Base packaging REST API Error."""
+
+
+class ShellNotFound(PackagingRestApiError):
+    pass
+
+
+class FeatureUnavailable(PackagingRestApiError):
+    pass
+
+
+class LoginFailedError(PackagingRestApiError):
+    pass

cloudshell_rest_api-9.0.2/cloudshell/rest/models.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+from attrs import define, field
+from typing_extensions import Self
+
+
+@define
+class UserInfo:
+    user_name: str
+    email: str
+
+    @classmethod
+    def from_dict(cls, info_dict: dict) -> Self:
+        return cls(
+            user_name=info_dict["Username"],
+            email=info_dict["Email"],
+        )
+
+
+@define
+class ExecutionEnvironmentType:
+    position: int
+    path: str
+
+    @classmethod
+    def from_dict(cls, info_dict: dict) -> Self:
+        return cls(
+            position=info_dict["Position"],
+            path=info_dict["Path"],
+        )
+
+
+@define
+class ShellInfo:
+    id: str = field(repr=False)  # noqa: A003
+    name: str
+    version: str
+    standard_type: str = field(repr=False)
+    modification_date: str = field(repr=False)
+    last_modified_by_user: UserInfo = field(repr=False)
+    author: str = field(repr=False)
+    is_official: bool
+    based_on: str = field(repr=False)
+    execution_environment_type: ExecutionEnvironmentType = field(repr=False)
+
+    @classmethod
+    def from_dict(cls, info_dict: dict) -> Self:
+        return cls(
+            id=info_dict["Id"],
+            name=info_dict["Name"],
+            version=info_dict["Version"],
+            standard_type=info_dict["StandardType"],
+            modification_date=info_dict["ModificationDate"],
+            last_modified_by_user=UserInfo.from_dict(info_dict["LastModifiedByUser"]),
+            author=info_dict["Author"],
+            is_official=info_dict["IsOfficial"],
+            based_on=info_dict["BasedOn"],
+            execution_environment_type=ExecutionEnvironmentType.from_dict(
+                info_dict["ExecutionEnvironmentType"]
+            ),
+        )
+
+
+@define
+class StandardInfo:
+    standard_name: str
+    versions: list[str]
+
+    @classmethod
+    def from_dict(cls, info_dict: dict) -> Self:
+        return cls(
+            standard_name=info_dict["StandardName"],
+            versions=info_dict["Versions"],
+        )

cloudshell_rest_api-9.0.2/cloudshell/rest/progress_bar.py

@@ -0,0 +1,66 @@
+from __future__ import annotations
+
+from collections.abc import Generator
+from contextlib import contextmanager
+
+from alive_progress import alive_bar
+from requests import Response
+from requests_toolbelt import MultipartEncoder, MultipartEncoderMonitor
+
+
+def iter_resp_with_pb(
+    resp: Response, show: bool = True, chunk: int = 4096
+) -> Generator[bytes, None, None]:
+    """Iterate over response content with progress bar.
+
+    The request should be streaming.
+    """
+    total = int(resp.headers.get("content-length", 0))
+
+    pb_context = alive_bar(
+        total,
+        unit="B",
+        scale=True,
+        disable=not show,
+    )
+
+    with pb_context as bar:
+        for data in resp.iter_content(chunk_size=chunk):
+            size = len(data)
+            bar(size)
+            yield data
+
+
+@contextmanager
+def upload_with_pb(data: dict, headers: dict, show: bool = True):
+    """Upload data with progress bar.
+
+    Returns a new data object which should be used in the request.
+    Updates the headers with the new content type.
+    """
+    e = MultipartEncoder(data)
+    pb_context = alive_bar(
+        e.len,
+        unit="B",
+        scale=True,
+        disable=not show,
+    )
+
+    with pb_context as bar:
+        m = MultipartEncoderMonitor(e, _create_upload_callback(bar))
+        headers["Content-Type"] = m.content_type
+
+        yield m
+
+
+def _create_upload_callback(bar):
+    bytes_read = 0
+
+    def callback(monitor):
+        nonlocal bytes_read
+        new_bytes = monitor.bytes_read - bytes_read
+        bytes_read = monitor.bytes_read
+        if new_bytes:
+            bar(new_bytes)
+
+    return callback

cloudshell_rest_api-9.0.2/cloudshell_rest_api.egg-info/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: cloudshell-rest-api
+Version: 9.0.2
+Summary: Python client for the CloudShell REST API
+Home-page: https://github.com/QualiSystems/cloudshell-rest-api
+Author: Boris Modylevsky
+Author-email: borismod@gmail.com
+License: Apache Software License 2.0
+Keywords: cloudshell quali sandbox cloud rest api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.9
+Requires-Python: ~=3.7
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: requests<3,>=2.23
+Requires-Dist: attrs<24,>=21
+Requires-Dist: typing-extensions>=4.4
+Requires-Dist: alive_progress~=3.0
+Requires-Dist: requests_toolbelt~=1.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 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 8.0)
+* Update Shell - updates an existing Shell Entity (supported from CloudShell 8.0)
+* 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
+