Metadata-Version: 2.1
Name: kisters.water.rest-client
Version: 0.0.8
Summary: Authenticated REST Client for the Kisters Water ecosystem
Home-page: https://gitlab.com/kisters/water/rest_client
Author: Jesse VanderWees
Author-email: jesse.vanderwees@kisters-bv.nl
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: msgpack
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

# Kisters REST Client Library

This library allows connections to Kisters servers. It supports authentication
with OpenID Connect.

## Installation

Install with `pip`:

```bash
> python -m pip install kisters.water.rest_client
```


## Example Usage

```python
from kisters.water.rest_client import RESTClient
from kisters.water.rest_client.auth import OpenIDConnect

# Instantiate the authentication class with credentials
authentication = OpenIDConnect(
    client_id="jesse-test",
    client_secret="c4b0f70d-d2e6-497f-b11c-d49fe806c29b",
)
# Instantiate the client class with the service url and authentication
client = RESTClient(
    url="https://jesse-test.hydraulic-network.kisters.cloud",
    authentication=authentication
)
# Verify the client is set up correctly
# Note: If you have not created any networks yet, this could be an empty list
client.get("rest/networks")
# ['my-network', 'my-other-network', ...]
```


