Skip to main content

An abstract interface for RabbitMQ communication

Project description

https://img.shields.io/pypi/v/b_rabbit.svg https://img.shields.io/travis/nidhaloff/b_rabbit.svg https://readthedocs.org/projects/b_rabbit/badge/?version=latest PyPI - Python Version PyPI - Wheel PyPI - Status https://pepy.tech/badge/b-rabbit https://pepy.tech/badge/b-rabbit/month GitHub last commit Twitter URL

RabbitMQ without headache.

b_rabbit is a RabbitMq Interface on top of rabbitpy to make implementing RabbitMQ messaging patterns easier. It is very useful especially inside large projects, in which many boilerplate code must be written. it uses a parent wrapper class that wrap all connections and classes definitions of different messaging patterns, then using the patterns is pretty straightforward by creating instances from the parent class depending on the pattern you want to use. it uses multithreading to asynchronously orchestrate between multiple subscription and RPCs.

Features

  • it implements all RabbitMQ messaging patterns.

  • provides an easy high level API (take a look at the examples)

  • thread safe since it uses rabbitpy

  • implementation of the publish-subscribe pattern

  • implementation of the Remote procedure call pattern

  • safe message delivery

When you should use it

  • if you are having problems with other non thread safe libraries (like I did)

  • if you want to develop fast by using a high level API

  • if you don’t want to write much code and save much time

  • if you want to use multithreading

  • if you want to get started with RabbitMQ

Why you should use it

  • High level of abstraction

  • Simple syntax and readability improvement

  • Scalablity (since it uses multiple channels but only one connection)

  • Asynchronous fast messaging

  • Code reusability

Quick Usage

import the library:

from b_rabbit import BRabbit

create a parent instance which provide a global rabbitMQ connection

rabbit = BRabbit(host='localhost', port=5672)

now, just one liner to publish a message:

publisher = rabbit.EventPublisher(b_rabbit=rabbit,
                                  publisher_name='pub').publish(routing_key='testing.test',
                                                                payload='Hello from publisher')

or if you want to subscribe and listen to a certain topic:

 def callback(msg):
    # do something with the received msg from the publisher
    print(f"msg received: {msg}")

# subscribe and run a listener in a thread

subscriber = rabbit.EventSubscriber(
                                b_rabbit=rabbit,
                                routing_key='testing.test',
                                publisher_name='pub',
                                event_listener=callback).subscribe_on_thread()

Advanced Usage using RPC

  • task requester

from b_rabbit import BRabbit


def taskResponseListener(body):
    print('Task Response received')
    print(str(body))


rabbit = BRabbit(host='localhost', port=5672)
taskRequesterSynchron = rabbit.TaskRequesterSynchron(b_rabbit=rabbit,
                                                     executor_name='test',
                                                     routing_key='testing.test',
                                                     response_listener=taskResponseListener)

taskRequesterSynchron.request_task('msg from requester')
rabbit.close_connection()
  • task responser (server)

from b_rabbit import BRabbit
import time

rabbit = BRabbit(host='localhost', port=5672)


def taskListener(server, body):
    print('Task Request received')
    print(str(body))
    time.sleep(5)
    server.send_return(payload="return this value to requester")


taskExecuter = rabbit.TaskExecutor(b_rabbit=rabbit,
                                   executor_name='test',
                                   routing_key='testing.test',
                                   task_listener=taskListener).run_task_on_thread()

Further

Take a look in the examples folder for more. b_rabbit implements also the remote procedure call (RPC) pattern

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

b_rabbit-1.1.8.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

b_rabbit-1.1.8-py2.py3-none-any.whl (8.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file b_rabbit-1.1.8.tar.gz.

File metadata

  • Download URL: b_rabbit-1.1.8.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.8

File hashes

Hashes for b_rabbit-1.1.8.tar.gz
Algorithm Hash digest
SHA256 37325c5e3237f1a3d38cf2037d66503522886cd605e507e7936a01fd4d40bec8
MD5 57e61509091167856cbf604af8b12b3b
BLAKE2b-256 87c38e9bc0bbc2bcf3875b3b7cc40a567f0827dffdfac1a5036fd4bb6a03c3e3

See more details on using hashes here.

File details

Details for the file b_rabbit-1.1.8-py2.py3-none-any.whl.

File metadata

  • Download URL: b_rabbit-1.1.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.8

File hashes

Hashes for b_rabbit-1.1.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a407b1ea08c4775b403c3f593a19c2accd832b63c46ef54e19f57de277513635
MD5 73e0784f4bc78cd7fa808b4ddfe19c55
BLAKE2b-256 b21307fe7b9ab86719ed899c3c8c524b91444c1ac1bd094b698e59fcb76ec6d5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page