Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

# Network Store Service

## Overview

This package implements a hydraulic network topology store by mapping structures such as tanks, reservoirs, and junctions onto the nodes of a graph, whereas structures such as channels, pipes, pumps, and valves are mapped onto graph edges.

The structure models are implemented as separate, open-source libraries:

Furthermore, KISTERS maintains a python client for easy scripting against the Network Store Service: [kisters.network_store.client.network](https://gitlab.com/kisters/network-store/client)

## Licence

The KISTERS Network Store Service (package name kisters.network-store.service) is distributed under the GNU Affero General Public License v3.0 (AGPLv3), with commercial licences available. See the [AGPLv3-LICENCE](AGPLv3-LICENCE) file for details about the AGPLv3 licence. To receive a commercial licence, contact [KISTERS](https://www.kisters.de/).

## Running

The service can be run locally using uvicorn (installable with pip):

`shell uvicorn kisters.network_store.service.padp.asgi.app:create_app --factory `

### Environment Variables

Variable | Default | Description |
———————– | ——- | ——————————————————– |
DEPLOYMENT_URL | - | The public url that the ASGI service is exposed at |
MONGODB_HOST | - | The MongoDB connection URI for the storage backend |
ENABLE_VIEWER | True | Enable experimental network viewer feature in Swagger UI |
ENABLE_ACCESS_CONTROL | False | Enable access control on all endpoints |

## Versioning

The package versioning attempts to follow semantic versioning. If the API is extended, a minor version will be released. If there is a breaking change to the API, the major version will be increased. Note that the modules exported by the python package are considered internal, the versions are based on the ASGI interface alone.

Metadata

Release files for kisters.network-store.service 1.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for kisters.network-store.service 1.4.0
File Interpreter ABI Platform
kisters.network_store.service-1.4.0-py3-none-any.whl Python 3 none any Details

Release files / kisters.network_store.service-1.4.0-py3-none-any.whl

Download URL kisters.network_store.service-1.4.0-py3-none-any.whl
Size 1.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
0e2f0b080adf5d05e484e29a40c397dd4e4c9e74826b316568a8d4f6a5d1d744
BLAKE2b-256 checksum
How to use checksums
52b9654770d4ea9e67dce745e8f6881f184afdb4937acf5922467ad719c020a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.15

Security for kisters.network-store.service 1.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page