Metadata-Version: 2.5
Name: msl-network
Version: 2.0.0
Summary: Transfer messages across a network
Project-URL: Changes, https://mslnz.github.io/msl-network/latest/release-notes/
Project-URL: Documentation, https://mslnz.github.io/msl-network/latest/
Project-URL: Homepage, https://mslnz.github.io/msl-network/latest/
Project-URL: Source, https://github.com/MSLNZ/msl-network
Project-URL: Tracker, https://github.com/MSLNZ/msl-network/issues
Author-email: Measurement Standards Laboratory of New Zealand <info@measurement.govt.nz>
Maintainer-email: Joseph Borbely <joseph.borbely@measurement.govt.nz>
License: MIT License
        
        Copyright (c) 2017 - 2026, Measurement Standards Laboratory of New Zealand
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Python: >=3.8
Requires-Dist: pyzmq
Description-Content-Type: text/markdown

# MSL-Network

[![CI Status](https://github.com/MSLNZ/msl-network/actions/workflows/ci.yml/badge.svg)](https://github.com/MSLNZ/msl-network/actions/workflows/ci.yml)
[![Docs Status](https://github.com/MSLNZ/msl-network/actions/workflows/docs.yml/badge.svg)](https://github.com/MSLNZ/msl-network/actions/workflows/docs.yml)
[![PyPI - Version](https://img.shields.io/pypi/v/msl-network?logo=pypi&logoColor=gold&label=PyPI&color=blue)](https://pypi.org/project/msl-network/)
[![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/msl-network.svg?logo=python&label=Python&logoColor=gold)](https://pypi.org/project/msl-network/)

`msl-network` uses concurrency and asynchronous programming to transfer messages across a network and it is composed of a [Broker], [Client]s and [Service]s with a [Link] established between a [Client] and a [Service].

A [Broker] uses concurrency to handle requests from multiple [Client]s such that multiple requests run in overlapping time periods and a reply is returned in no specific order. The [Broker] also distributes messages that are published by a [Service] to all [Client]s that are subscribed.

A [Client] can send requests synchronously or asynchronously for a [Service] to execute.

## Install

`msl-network` is available for installation via the [Python Package Index](https://pypi.org/project/msl-network/)

```console
pip install msl-network
```

### Dependencies

* Python 3.8+
* [PyZMQ]

## Documentation

The documentation for `msl-network` can be found [here](https://mslnz.github.io/msl-network/latest/).

[Broker]: https://mslnz.github.io/msl-network/latest/#broker
[Client]: https://mslnz.github.io/msl-network/latest/api/client/
[Service]: https://mslnz.github.io/msl-network/latest/api/service/
[Link]: https://mslnz.github.io/msl-network/latest/api/link/
[PyZMQ]: https://pyzmq.readthedocs.io/en/latest/
