nextlayer-sdk-python 1.0.1__tar.gz → 1.0.2__tar.gz

{nextlayer_sdk_python-1.0.1 → nextlayer_sdk_python-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nextlayer-sdk-python
-Version: 1.0.1
+Version: 1.0.2
 Summary: Client utilities to interact with next layer public APIs
 Author: Wolfgang Powisch
 Author-email: wolfgang.powisch@nextlayer.at
@@ -23,8 +23,8 @@ Client utilities to interact with next layer public APIs.
 
 ## Configuration
 
-The module will use a YAML Config file in , where it also needs to **write** to, to store
-and update the obtained Tokens and their expiry (similar like `kubctl` does with kubeconfig).
+The module will use a YAML Config file to read it's configuration and also **writes** to it,
+to store obtained Tokens and their expiry (similar like `kubctl` does with kubeconfig).
 
 _Example `~/.nextlayer-sdk/auth.nlcustomers.yml`:_
 
@@ -44,7 +44,7 @@ Except for `username`, all settings are optional, but if no `password` is
 supplied in config, the password will be asked interactively (if STDIN is a TTY) !
 
 Alternatively the username can be suppled in the `NEXTLAYERSDK_USERNAME` environment
-variable or directly passed to the `NlAuth` cosntructor.
+variable or directly passed to the `NlAuth` constructor.
 
 Alternatively the password can be suppliend in the `NEXTLAYERSDK_PASSWORD` environment
 variable.
@@ -63,6 +63,7 @@ rsp = requests.get(
     "https://portal.nextlayer.at/apis/v1/users/self",
     headers={"Authorization": "Bearer " + access_token},
 )
+print(rsp.json())
 ```
 
 You need to call the `.get_access_token()` Method **every time** you make API-Calls,
@@ -77,8 +78,23 @@ from nextlayer.sdk.auth_httpx import NlHttpxAuth
 
 client = httpx.Client(
     timeout=httpx.Timeout(30.0),
-    base_url=f"{base_url}/api/v2",
+    base_url=f"https://portal.nextlayer.at/apis/v1",
     auth=NlHttpxAuth(),
 )
+print(client.get("/users/self").json())
+```
+
+## Usage fron commandline
+
+The package also installs a commandline utility `nextlayer-auth` which takes care
+of obtaining an access token and printing out a proper `Authorization:` header.
+
+```bash
+curl -H "`nextlayer-auth`" https://portal.nextlayer.at/apis/v1/users/self
+```
+
+It can also be used to "logout" by cleaning up tokens in the yaml file with:
+```
+nextlayer-auth clear
 ```
 

{nextlayer_sdk_python-1.0.1 → nextlayer_sdk_python-1.0.2}/README.md

@@ -4,8 +4,8 @@ Client utilities to interact with next layer public APIs.
 
 ## Configuration
 
-The module will use a YAML Config file in , where it also needs to **write** to, to store
-and update the obtained Tokens and their expiry (similar like `kubctl` does with kubeconfig).
+The module will use a YAML Config file to read it's configuration and also **writes** to it,
+to store obtained Tokens and their expiry (similar like `kubctl` does with kubeconfig).
 
 _Example `~/.nextlayer-sdk/auth.nlcustomers.yml`:_
 
@@ -25,7 +25,7 @@ Except for `username`, all settings are optional, but if no `password` is
 supplied in config, the password will be asked interactively (if STDIN is a TTY) !
 
 Alternatively the username can be suppled in the `NEXTLAYERSDK_USERNAME` environment
-variable or directly passed to the `NlAuth` cosntructor.
+variable or directly passed to the `NlAuth` constructor.
 
 Alternatively the password can be suppliend in the `NEXTLAYERSDK_PASSWORD` environment
 variable.
@@ -44,6 +44,7 @@ rsp = requests.get(
     "https://portal.nextlayer.at/apis/v1/users/self",
     headers={"Authorization": "Bearer " + access_token},
 )
+print(rsp.json())
 ```
 
 You need to call the `.get_access_token()` Method **every time** you make API-Calls,
@@ -58,7 +59,22 @@ from nextlayer.sdk.auth_httpx import NlHttpxAuth
 
 client = httpx.Client(
     timeout=httpx.Timeout(30.0),
-    base_url=f"{base_url}/api/v2",
+    base_url=f"https://portal.nextlayer.at/apis/v1",
     auth=NlHttpxAuth(),
 )
+print(client.get("/users/self").json())
+```
+
+## Usage fron commandline
+
+The package also installs a commandline utility `nextlayer-auth` which takes care
+of obtaining an access token and printing out a proper `Authorization:` header.
+
+```bash
+curl -H "`nextlayer-auth`" https://portal.nextlayer.at/apis/v1/users/self
+```
+
+It can also be used to "logout" by cleaning up tokens in the yaml file with:
+```
+nextlayer-auth clear
 ```

{nextlayer_sdk_python-1.0.1 → nextlayer_sdk_python-1.0.2}/pyproject.toml

@@ -3,7 +3,7 @@ name = "nextlayer-sdk-python"
 packages = [
     { include = "nextlayer", from="src" }
 ]
-version = "v1.0.1"
+version = "v1.0.2"
 description = "Client utilities to interact with next layer public APIs"
 readme = "README.md"
 authors = ["Wolfgang Powisch <wolfgang.powisch@nextlayer.at>"]

{nextlayer_sdk_python-1.0.1 → nextlayer_sdk_python-1.0.2}/src/nextlayer/sdk/__init__.py

@@ -1,2 +1,2 @@
 # do not edit this version line, it will be updated in CI-Pipeline!
-__version__ = "v1.0.1"
+__version__ = "v1.0.2"