| Name | QuickMQ JSON |
| Version |
0.9.7
JSON |
| download |
| home_page | |
| Summary | An easy-to-use RabbitMQ client. |
| upload_time | 2024-03-06 17:46:19 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6.8 |
| license | MIT License Copyright (c) [2020] [Max Drexler] 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. |
| keywords |
rabbitmq
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# QuickMQ
An easy-to-use RabbitMQ client.
[](https://gitlab.ssec.wisc.edu/mdrexler/easymq/-/commits/main)
[](https://gitlab.ssec.wisc.edu/mdrexler/easymq/-/commits/main)
[](https://gitlab.ssec.wisc.edu/mdrexler/easymq/-/releases)
## Table of Contents
* [Description](#description)
* [Installation](#installation)
* [Features](#features)
* [Docs](#documentation)
* [Contributing](#contributing)
* [Author](#author)
## Description
QuickMQ is a purely python implementation of a RabbitMQ client. QuickMQ abstracts quite a few RabbitMQ concepts like channels, publisher confirms, and message encoding to make interacting with RabbitMQ as easy as possible.
These abstractions make the package a good fit for anyone looking to quickly and easily interact with RabbitMQ servers.
### What QuickMQ ***Cannot*** Do
* Work queues
* Transactions
* Consumer confirmations
QuickMQ is simple on purpose, so if you require the above features or the abstractions don't work well for you, clients like [pika](https://github.com/pika/pika) or [aio-pika](https://github.com/mosquito/aio-pika) might be a better fit.
## Installation
QuickMQ is currently still being tested, but it can be installed from the PyPI index.
```bash
pip install quickmq
```
To install the most recent version from GitLab.
```bash
pip install git+https://gitlab.ssec.wisc.edu/mdrexler/quickmq.git
```
### Requirements
Python >= 3.6
## Features
QuickMQ comes with some useful features, all which are easy to use.
### Multi-Server Actions
With QuickMQ you're able to connect to and publish/listen for messages from multiple servers at the same time.
```python3
import quickmq.api as mq
mq.connect('server1', 'server2', auth=('user', 'pass'))
mq.publish('Hello World!') # publishes to both servers
```
### Automatic Reconnection
Server connections can reconnect automatically in case of sporatic drops.
```python3
import quickmq.api as mq
# Connections will try to reconnect 3 times,
# waiting a minute between each attempt
my_cfg = mq.configure(RECONNECT_DELAY=60, RECONNECT_TRIES=3)
mq.connect('destination', cfg=my_cfg)
```
### Queue Messages While Reconnecting
It's possible to queue messages while a connection is reconnecting and publish them when the server connections again. The default behavior is to drop all messages when the connection is reconnecting.
```python3
import quickmq.api as mq
my_cfg = mq.configure(DROP_WHILE_RECONENCT=False)
mq.connect('destination', cfg=my_cfg)
```
### Command Line Interface
QuickMQ also installs with a CLI for use outside of python scripts.
```bash
quickmq publish -e exchange -s server(s) -u username -p password
```
Use `quickmq --help` for more information.
## Documentation
See the GitLab [wiki](https://gitlab.ssec.wisc.edu/mdrexler/easymq/-/wikis/home) for more documentation.
## Contributing
Contributions welcome!
Docker is required to run tests.
To run tests simply use the Makefile:
```bash
make test
```
## Author
Created/Maintained by [Max Drexler](mailto:mndrexler@wisc.edu)
## License
MIT License. See LICENSE for more information.
Raw data
{
"_id": null,
"home_page": "",
"name": "QuickMQ",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.8",
"maintainer_email": "",
"keywords": "rabbitmq",
"author": "",
"author_email": "Max Drexler <mndrexler@wisc.edu>",
"download_url": "https://files.pythonhosted.org/packages/d9/a6/3ab1a1cb785a8bebaee42cf0f365cd0c9d4773f0b6aa17463a6d4ebf465b/QuickMQ-0.9.7.tar.gz",
"platform": null,
"description": "# QuickMQ\n\nAn easy-to-use RabbitMQ client.\n\n[](https://gitlab.ssec.wisc.edu/mdrexler/easymq/-/commits/main)\n[](https://gitlab.ssec.wisc.edu/mdrexler/easymq/-/commits/main)\n[](https://gitlab.ssec.wisc.edu/mdrexler/easymq/-/releases)\n\n## Table of Contents\n\n* [Description](#description)\n* [Installation](#installation)\n* [Features](#features)\n* [Docs](#documentation)\n* [Contributing](#contributing)\n* [Author](#author)\n\n## Description\n\nQuickMQ is a purely python implementation of a RabbitMQ client. QuickMQ abstracts quite a few RabbitMQ concepts like channels, publisher confirms, and message encoding to make interacting with RabbitMQ as easy as possible. \n\nThese abstractions make the package a good fit for anyone looking to quickly and easily interact with RabbitMQ servers.\n\n### What QuickMQ ***Cannot*** Do\n\n* Work queues\n* Transactions\n* Consumer confirmations\n\nQuickMQ is simple on purpose, so if you require the above features or the abstractions don't work well for you, clients like [pika](https://github.com/pika/pika) or [aio-pika](https://github.com/mosquito/aio-pika) might be a better fit.\n\n## Installation\n\nQuickMQ is currently still being tested, but it can be installed from the PyPI index.\n\n```bash\npip install quickmq\n```\n\nTo install the most recent version from GitLab.\n\n```bash\npip install git+https://gitlab.ssec.wisc.edu/mdrexler/quickmq.git\n```\n\n### Requirements\n\nPython >= 3.6\n\n## Features\n\nQuickMQ comes with some useful features, all which are easy to use.\n\n### Multi-Server Actions\n\nWith QuickMQ you're able to connect to and publish/listen for messages from multiple servers at the same time.\n\n```python3\nimport quickmq.api as mq\n\nmq.connect('server1', 'server2', auth=('user', 'pass'))\n\nmq.publish('Hello World!') # publishes to both servers\n```\n\n### Automatic Reconnection\n\nServer connections can reconnect automatically in case of sporatic drops.\n\n```python3\nimport quickmq.api as mq\n\n# Connections will try to reconnect 3 times,\n# waiting a minute between each attempt\nmy_cfg = mq.configure(RECONNECT_DELAY=60, RECONNECT_TRIES=3)\n\nmq.connect('destination', cfg=my_cfg)\n```\n\n### Queue Messages While Reconnecting\n\nIt's possible to queue messages while a connection is reconnecting and publish them when the server connections again. The default behavior is to drop all messages when the connection is reconnecting.\n\n```python3\nimport quickmq.api as mq\n\nmy_cfg = mq.configure(DROP_WHILE_RECONENCT=False)\n\nmq.connect('destination', cfg=my_cfg)\n```\n\n### Command Line Interface\n\nQuickMQ also installs with a CLI for use outside of python scripts.\n\n```bash\nquickmq publish -e exchange -s server(s) -u username -p password\n```\n\nUse `quickmq --help` for more information.\n\n## Documentation\n\nSee the GitLab [wiki](https://gitlab.ssec.wisc.edu/mdrexler/easymq/-/wikis/home) for more documentation.\n\n## Contributing\n\nContributions welcome! \n\nDocker is required to run tests. \nTo run tests simply use the Makefile:\n\n```bash\nmake test\n```\n\n## Author\n\nCreated/Maintained by [Max Drexler](mailto:mndrexler@wisc.edu)\n\n## License\n\nMIT License. See LICENSE for more information.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) [2020] [Max Drexler] 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.",
"summary": "An easy-to-use RabbitMQ client.",
"version": "0.9.7",
"project_urls": {
"Issues": "https://gitlab.ssec.wisc.edu/mdrexler/easymq/-/issues",
"Repository": "https://gitlab.ssec.wisc.edu/mdrexler/easymq"
},
"split_keywords": [
"rabbitmq"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f66831f653e7e8a382b8246bdc8fe75f6e177be6dd218c26087ca6b26290554",
"md5": "e24376a38ce2bc766335772380793a19",
"sha256": "7b33228b0791645a46c8be7b80b6ed0fecd7d46c63db35e0e24f1f3f8ea32a81"
},
"downloads": -1,
"filename": "QuickMQ-0.9.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e24376a38ce2bc766335772380793a19",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.8",
"size": 16170,
"upload_time": "2024-03-06T17:46:13",
"upload_time_iso_8601": "2024-03-06T17:46:13.934541Z",
"url": "https://files.pythonhosted.org/packages/9f/66/831f653e7e8a382b8246bdc8fe75f6e177be6dd218c26087ca6b26290554/QuickMQ-0.9.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d9a63ab1a1cb785a8bebaee42cf0f365cd0c9d4773f0b6aa17463a6d4ebf465b",
"md5": "e4974220bf83e632d37f66b5c49a397c",
"sha256": "dbeff10d07b0495f0fa3467514557c3c4570c2342559610ccac81f69f179a6ce"
},
"downloads": -1,
"filename": "QuickMQ-0.9.7.tar.gz",
"has_sig": false,
"md5_digest": "e4974220bf83e632d37f66b5c49a397c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.8",
"size": 13785,
"upload_time": "2024-03-06T17:46:19",
"upload_time_iso_8601": "2024-03-06T17:46:19.440873Z",
"url": "https://files.pythonhosted.org/packages/d9/a6/3ab1a1cb785a8bebaee42cf0f365cd0c9d4773f0b6aa17463a6d4ebf465b/QuickMQ-0.9.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-06 17:46:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "quickmq"
}
