Skip to main content

Client library for the Kisters Network Store service

Project description

Hydraulic Network Client Library

This library allows connections to remote hydraulic network REST servers. It supports authentication with OpenID Connect.

Installation

Install with pip:

> python -m pip install kisters.network_store.client.network
# or you if also need the water models
> python -m pip install kisters.network_store.client.network[water]

Example Usage

Create the Kisters REST Client

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


rest_client = RESTClient(
    url="https://jesse-test.hydraulic-network.kisters.cloud",
    authentication=OpenIDConnect(
        client_id="jesse-test",
        client_secret="c4b0f70d-d2e6-497f-b11c-d49fe806c29b",
    ),
)

# Verify the client is set up correctly
# Note: If you have not created any networks yet, this could be an empty list
rest_client.get(("rest", "networks"))
# ['my-network', 'my-other-network', ...]

Connect to a Network

from kisters.network_store.client.network import Network


# Instantiate the Network class with the network name and client
network = Network("my-network", rest_client)

# You can now access the properties of the network
network.get_nodes()
# [
# FlowBoundary(
#     created=datetime.datetime(2019, 6, 27, 16, 53, 5),
#     uid='flow_boundary',
#     display_name='flow_boundary',
#     location={'x': 0.0, 'y': 0.0, 'z': 0.0},
#     schematic_location={'x': 0.0, 'y': 0.0, 'z': 0.0})
# ,
# ...
# ]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file kisters.network_store.client.network-0.4.2.tar.gz.

File metadata

  • Download URL: kisters.network_store.client.network-0.4.2.tar.gz
  • Upload date:
  • Size: 17.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for kisters.network_store.client.network-0.4.2.tar.gz
Algorithm Hash digest
SHA256 c2bc386539ca963b21602e1ddd752811abf9857074923a6ebfb10d44c5b09301
MD5 c0b6b1fb91cf36347ba11aeb34a38913
BLAKE2b-256 ade2e05ba70e57e4b7933ed9267b145352119acd67427bc6232e1048091339b3

See more details on using hashes here.

File details

Details for the file kisters.network_store.client.network-0.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for kisters.network_store.client.network-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6a94a38aabe85623c750ae9c7b6f8c40e44a32e726ff1d04f42ea6f296576343
MD5 b981c71ac72f45f844157e8bd23b40f5
BLAKE2b-256 3d0c177fa89f876e363abb0ce041d63878c4d753a89059d03aae239d4ff841da

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page