Metadata-Version: 2.1
Name: heraut
Version: 0.0.1.dev1
Summary: The herald of python message passing between threads and processes
Home-page: https://github.com/mkupperman/heraut
Author: Michael Kupperman
Author-email: kupperma@uw.edu
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/mkupperman/heraut/issues
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: watchdog (>=2.0.0)

# Heraut

Heraut, the herald of pythonic message passing.

A python 3.6+ package for message passing between threads and processes.

## Minimal example:

#### Sending Information

```python

from src import heraut

# Initialize the sender, once per process per sender
sender = heraut.Sender(name='process A')
# Send the message
sender.send(message='hello world', label='', target='process B')
# Tell the listner no more messages will be coming. 
sender.stop_listener(target='process B')
```

#### Recieving Information

```python

from src import heraut

listener = heraut.Listener()
flag = True
while flag and listener.listening():
    # get the message
    flag, message, label, metadata = listener.get_message()
    # do something with the message
    print(message)
# Shut down the listner. 
listener.end()
```


