Update deps and up patch release

ollionorg · Mar 27, 2020 · 5b61306 · 5b61306
1 parent 96389f1
commit 5b61306
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 22 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -5,3 +5,33 @@ reference/
 .mypy_cache/
 .pytest_cache/
 .github/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Docs
+_build/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# pyenv
+.python-version
diff --git a/README.md b/README.md
@@ -10,17 +10,24 @@ Python wrapper and CLI for [CloudEndure](https://www.cloudendure.com/)
 
 ## Installation & Usage
 
-### poetry
+### Basic Installation / pip
+
+```sh
+pip install cloudendure
+cloudendure version
+```
+
+### Local Development with Poetry
 
 ```sh
 brew install poetry # if not installed
-poetry install cloudendure
+poetry install
 ```
 
-### pip
+### Local Development with Docker
 
 ```sh
-pip install cloudendure
+docker run --rm -it cloudendurepy/cloudendure bash
 ```
 
 ### Usage

diff --git a/cloudendure/api.py b/cloudendure/api.py
@@ -147,9 +147,17 @@ def login(self, username: str = "", password: str = "", token: str = "") -> bool
         return True
 
     @staticmethod
-    def get_endpoint(path: str, api_version: str = "latest", host: str = "https://console.cloudendure.com",) -> str:
+    def get_endpoint(path: str, api_version: str = "latest", host: str = "https://console.cloudendure.com") -> str:
         """Build the endpoint path.
 
+        Args:
+            path (str): The path to be requested.
+            api_version (str): The API version to be used.
+                For example: v5
+                Defaults to: latest
+            host (str): The API URL to be used.
+                Defaults to: https://console.cloudendure.com
+
         Returns:
             str: The CloudEndure API endpoint to be used.
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cloudendure"
-version = "0.2.2"
+version = "0.2.3"
 description = "Python wrapper and CLI for CloudEndure"
 authors = ["Mark Beacom <[email protected]>", "Tom Warnock <[email protected]>"]
 maintainers = ["Evan Lucchesi <[email protected]>", "Nick Selpa <[email protected]>"]