Skip to content

Commit 5b61306

Browse files
committed
Update deps and up patch release
1 parent 96389f1 commit 5b61306

File tree

5 files changed

+67
-22
lines changed

5 files changed

+67
-22
lines changed

.dockerignore

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,33 @@ reference/
55
.mypy_cache/
66
.pytest_cache/
77
.github/
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
*.egg-info/
24+
.installed.cfg
25+
*.egg
26+
MANIFEST
27+
28+
# Docs
29+
_build/
30+
31+
# Byte-compiled / optimized / DLL files
32+
__pycache__/
33+
*.py[cod]
34+
*$py.class
35+
36+
# pyenv
37+
.python-version

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,24 @@ Python wrapper and CLI for [CloudEndure](https://www.cloudendure.com/)
1010

1111
## Installation & Usage
1212

13-
### poetry
13+
### Basic Installation / pip
14+
15+
```sh
16+
pip install cloudendure
17+
cloudendure version
18+
```
19+
20+
### Local Development with Poetry
1421

1522
```sh
1623
brew install poetry # if not installed
17-
poetry install cloudendure
24+
poetry install
1825
```
1926

20-
### pip
27+
### Local Development with Docker
2128

2229
```sh
23-
pip install cloudendure
30+
docker run --rm -it cloudendurepy/cloudendure bash
2431
```
2532

2633
### Usage

cloudendure/api.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,9 +147,17 @@ def login(self, username: str = "", password: str = "", token: str = "") -> bool
147147
return True
148148

149149
@staticmethod
150-
def get_endpoint(path: str, api_version: str = "latest", host: str = "https://console.cloudendure.com",) -> str:
150+
def get_endpoint(path: str, api_version: str = "latest", host: str = "https://console.cloudendure.com") -> str:
151151
"""Build the endpoint path.
152152
153+
Args:
154+
path (str): The path to be requested.
155+
api_version (str): The API version to be used.
156+
For example: v5
157+
Defaults to: latest
158+
host (str): The API URL to be used.
159+
Defaults to: https://console.cloudendure.com
160+
153161
Returns:
154162
str: The CloudEndure API endpoint to be used.
155163

poetry.lock

Lines changed: 16 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "cloudendure"
3-
version = "0.2.2"
3+
version = "0.2.3"
44
description = "Python wrapper and CLI for CloudEndure"
55
authors = ["Mark Beacom <[email protected]>", "Tom Warnock <[email protected]>"]
66
maintainers = ["Evan Lucchesi <[email protected]>", "Nick Selpa <[email protected]>"]

0 commit comments

Comments
 (0)