Skip to content

Commit 26d100f

Browse files
authored
Merge pull request #1 from QualiSystemsLab/class-refactor
Class refactor
2 parents 83aebc3 + 81a2895 commit 26d100f

25 files changed

+776
-416
lines changed

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.idea/
2+
.pytest_cache/
3+
*.egg
4+
*.egg-info
5+
tests/.env
6+
*.zip
7+
dist/
8+
build/
9+
*.pyc
10+
venv

.pre-commit-config.yaml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
repos:
2+
- repo: https://github.com/timothycrosley/isort
3+
rev: 5.4.2
4+
hooks:
5+
- id: isort
6+
language_version: python3.7
7+
args: [ --line-length=127 ]
8+
- repo: https://github.com/python/black
9+
rev: 20.8b1
10+
hooks:
11+
- id: black
12+
language_version: python3.7
13+
args: [ --line-length=127 ]
14+
- repo: https://gitlab.com/pycqa/flake8
15+
rev: 3.8.3
16+
hooks:
17+
- id: flake8
18+
additional_dependencies: [
19+
flake8-docstrings,
20+
flake8-builtins,
21+
flake8-comprehensions,
22+
flake8-print,
23+
flake8-eradicate,
24+
]
25+
language_version: python3.7
26+
args: [
27+
--max-line-length=127,
28+
'--ignore=D100,D101,D102,D103,D104,D105,D106,D107,D200,D205,D210,D400,D401,W503,E203,F403,F405,T001'
29+
]
30+
# See https://stackoverflow.com/questions/61238318/pylint-and-pre-commit-hook-unable-to-import/61238571#61238571
31+
- repo: local
32+
hooks:
33+
- id: pylint
34+
name: pylint
35+
entry: pylint
36+
language: system
37+
types: [ python ]
38+
args: [
39+
--max-line-length=127,
40+
--max-public-methods=32,
41+
--max-args=13,
42+
'--disable=too-few-public-methods,logging-fstring-interpolation,too-many-instance-attributes,no-else-return,too-many-locals,no-self-use,duplicate-code,broad-except,logging-not-lazy,unspecified-encoding, unused-wildcard-import,missing-function-docstring,missing-module-docstring,import-error,wildcard-import,invalid-name,redefined-outer-name,no-name-in-module, arguments-differ',
43+
'--good-names=ip,rc,eval'
44+
]

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
MIT License
3+
4+
Copyright (c) 2021
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.

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.

0 commit comments

Comments
 (0)