Skip to main content

A Quart thing to handle pubsub tasks in particular the event source

Project description

bovine_pubsub

bovine_pubsub is a simple wrapper to enable server sent events in bovine. These are used to communicate real time with clients without forcing them to use polling. If multiple workers are used with bovine, one needs to use Redis as the implementation with queues only works for a single process.

Starting with bovine-pubsub support for server side clients is available using AMQP. See examples/bovine_listen.py for details.

Usage

The simplest usage example is given by

from quart import Quart
from bovine_pubsub import BovinePubSub

app = Quart(__name__)
BovinePubSub(app)

it adds the config variable app.config["bovine_pub_sub"] to the Quart application. By calling

await app.config["bovine_pub_sub"].send("channel:test", b"test")

one sends the bytes b"test" to the channel channel:test. By calling

pub_sub.event_stream("channel:test")

one receives an async iterator that can be used as server sent events.

Example usage

A usage example is provided by examples/basic_app.py. By running

python examples/basic.app

one can start a server that sends "test" 10 times a new socket is opened on localhost:5000. The above implementation will use the local queues. To use with Redis start

BOVINE_REDIS=redis://localhost:6379 python examples/basic_app.py 

with an appropriate value for the environment variable BOVINE_REDIS.

Running tests

Testing redis can be done inside of the docker compose setup, e.g.

docker compose up -d
docker compose run main /bin/sh
cd bovine_pubsub
poetry install
poetry run pytest
BOVINE_REDIS=redis://redis:6379 poetry run pytest
BOVINE_AMQP=amqp://rabbitmq poetry run pytest

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

bovine_pubsub-0.5.11.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

bovine_pubsub-0.5.11-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file bovine_pubsub-0.5.11.tar.gz.

File metadata

  • Download URL: bovine_pubsub-0.5.11.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.11.3 Linux/6.1.0-20-amd64

File hashes

Hashes for bovine_pubsub-0.5.11.tar.gz
Algorithm Hash digest
SHA256 51f50b2e64b677a81bae0b107fd37b7879f492bc2a083077fcec3633bcdf4bcd
MD5 6e7cd2f03f338d31f2e2dc2f565ad17a
BLAKE2b-256 9071f2754f6fbc25e50e6401ae64352a6f82291127a72158e9b6538327e3d00d

See more details on using hashes here.

File details

Details for the file bovine_pubsub-0.5.11-py3-none-any.whl.

File metadata

  • Download URL: bovine_pubsub-0.5.11-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.11.3 Linux/6.1.0-20-amd64

File hashes

Hashes for bovine_pubsub-0.5.11-py3-none-any.whl
Algorithm Hash digest
SHA256 70269e908b20ddabc3acfb87d8e5d67b55972e3079e78318286c477737912533
MD5 75f38db81e56e000053aab849ea11cff
BLAKE2b-256 0e1a4ea8f7b06f7b074fb0bf9f9aafaf0532a127f6d25b3c1ebdef8879a4e426

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