Metadata-Version: 2.1
Name: python-bunny-mq
Version: 0.1.8
Summary: Ultra-lightweight (no-dependency) message queue for intra-process pub-sub communication.
Home-page: https://pypi.org/project/python-bunny-mq/
License: Unlicense
Author: Steven Miers
Author-email: steven.miers@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Project-URL: Documentation, https://tangledpath.github.io/python-bunny-mq
Project-URL: Repository, https://github.com/tangledpath/python-bunny-mq
Description-Content-Type: text/markdown

# Python Bunny MQ
Python-based package that implements a no-dependency, ultra-lightweight intra-process message queue.  This works inside a single process, running in a separate thread.
![](https://raw.githubusercontent.com/tangledpath/python-bunny-mq/master/bunny-sm.png)

* This is useful when you need a lightweight pub-sub system.
* Introduce intra-process decoupling without running a separate service. 
* It is backed by python's multiproducer, multiconsumer [queue](https://docs.python.org/3/library/queue.html).  


## Homepage
https://pypi.org/project/python-bunny-mq/

## GitHub
https://github.com/tangledpath/python-bunny-mq

## Documentation
https://tangledpath.github.io/python-bunny-mq

## Installation
pip install python-bunny-mq

## Getting started
## Development
### Linting 
Linting is done via autopep8
```bash
script/lint.sh
```

### Documentation
```
# Shows in browser
poetry run pdoc python_bunny_mq/
# Generates to ./docs
script/build.sh
```

### Testing
```bash
  clear; pytest
```

### Building and Publishing
#### Building
```bash
scriopt/build.sh
```
#### Publishing
Note: `--build` flag build before publishing
```bash
script/publish.sh
# poetry publish --build -u __token__ -p $PYPI_TOKEN
```

