Skip to content

Commit a6c162f

Browse files
committed
updated docs
1 parent e2f15db commit a6c162f

File tree

6 files changed

+26
-33
lines changed

6 files changed

+26
-33
lines changed

README.MD

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python/)
2+
[![PyPI version](https://badge.fury.io/py/cloudshell-sandboxapi-wrapper.svg)](https://badge.fury.io/py/cloudshell-sandboxapi-wrapper)
3+
4+
# Cloudshell Sandbox API Wrapper
5+
A python client implementation of the [cloudshell sandbox api](https://help.quali.com/Online%20Help/0.0/Portal/Content/API/CS-Snbx-API-Topic.htm?Highlight=sandbox%20api).
6+
7+
This client provides an object-oriented interface to instantiating an api session and interacting with the endpoints.
8+
All methods return a loaded python dictionary/list of the [documented](https://help.quali.com/Online%20Help/0.0/Portal/Content/API/RefGuides/Sndbx-REST-API/REST-API-V2-Ref-Guide.htm?tocpath=CloudShell%20API%20Guide%7CCloudShell%20Sandbox%20API%7C_____3) json responses.
9+
No additional library object wrapping implemented.
10+
11+
12+
### Installation
13+
14+
```
15+
pip install cloudshell_sandboxapi_wrapper
16+
```
17+
## Usage
18+
```python
19+
pass
20+
```

README.rst

Lines changed: 0 additions & 27 deletions
This file was deleted.

cloudshell_sandboxapi_wrapper.egg-info/PKG-INFO

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Name: cloudshell-sandboxapi-wrapper
33
Version: 2.0.0
44
Summary: Python client for CloudShell Sandbox REST api - consume sandboxes via CI
55
Home-page: https://github.com/QualiSystemsLab/Sandbox-API-Python
6-
Author: sadanand.s
7-
Author-email: sadanand.s@quali.com
6+
Author: Quali
7+
Author-email: support@qualisystems.com
88
License: Apache 2.0
99
Keywords: cloudshell,sandbox,api,CI
1010
Platform: UNKNOWN

cloudshell_sandboxapi_wrapper.egg-info/SOURCES.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@ README.rst
22
setup.py
33
cloudshell/__init__.py
44
cloudshell/sandbox_rest/__init__.py
5+
cloudshell/sandbox_rest/exceptions.py
56
cloudshell/sandbox_rest/sandbox_api.py
6-
cloudshell/sandbox_rest/exceptions/__init__.py
7-
cloudshell/sandbox_rest/exceptions/sandbox_api_exceptions.py
87
cloudshell_sandboxapi_wrapper.egg-info/PKG-INFO
98
cloudshell_sandboxapi_wrapper.egg-info/SOURCES.txt
109
cloudshell_sandboxapi_wrapper.egg-info/dependency_links.txt
-4.98 KB
Binary file not shown.

setup.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,15 @@ def lines_from_file(file_name: str) -> List[str]:
1818
setup(
1919
name="cloudshell_sandboxapi_wrapper",
2020
description="Python client for CloudShell Sandbox REST api - consume sandboxes via CI",
21-
keywords=["cloudshell", "sandbox", "api", "CI"],
21+
keywords=["cloudshell", "sandbox", "api", "rest", "CI"],
2222
url="https://github.com/QualiSystemsLab/Sandbox-API-Python",
2323
author="sadanand.s",
2424
author_email="sadanand.s@quali.com",
2525
license="Apache 2.0",
2626
packages=find_packages(),
2727
version=read_file("version.txt"),
28-
long_description=read_file("README.rst"),
28+
long_description=read_file("README.MD"),
29+
long_description_content_type='text/markdown',
2930
install_requires=lines_from_file("requirements.txt"),
3031
test_requires=lines_from_file("test-requirements.txt"),
3132
classifiers=[

0 commit comments

Comments
 (0)