Skip to main content

general sugarcoat for all pubsub flavors.

Project description

tesselite-pubsub

general sugarcoat for all pubsub flavors.

pubsub

Publish Subscribe is a pretty simple mechanism understandable by any human.

For example, it is the ruling mechanism of all Social Networks.

But, yet very complex to code in Python given the variety of backends logic (redis, rabbitMQ, kafka, GCP PubSub, Azure Event Hubs..)

The goal of this library is to streamline the coding of Pubsub in two simple calls:


usage

Available Brokers:

internal name official name client library
gcp-pubsub Goggle Cloud Pubsub google-cloud-pubsub = "^2.26.1"
redis Redis redis = "^5.1.1"

low level usage

consume

from tesselite.pubsub import pubsubFactory

def callback(message): # callback function inputs serialized message 
    print(f"received this: {message}")
    
# consume loop
with pubsubFactory(broker="gcp-pubsub")(topic="tesselite-pubsub", log_name="consumer") as pubsub:
    pubsub.consume(callback=callback, deadLetter=None, subscription="tesselite")

publish

from tesselite.pubsub import pubsubFactory

def encoder(): # callback function inputs serialized message 
    yield "hello world"
    
# publish loop
with pubsubFactory(broker="gcp-pubsub")(topic="tesselite-pubsub", log_name="publisher") as pubsub:
    for msg in encoder():
        pubsub.publish(msg)

high level usage

consume

from tesselite.samples import consume # importing consume sample


def callback(message): # callback function inputs serialized message 
    print(f"received this: {message}")

if __name__ == '__main__':
    consume(broker='gcp-pubsub', callback=callback) # single-lined consume loop (default topic: tesselite-pubsub

publish

from tesselite.samples import consume # importing consume sample


def callback(message): # callback function inputs serialized message 
    print(f"received this: {message}")

if __name__ == '__main__':
    consume(broker='gcp-pubsub', callback=callback) # single-lined consume loop (default topic: tesselite-pubsub

Behavior

Best Case Scenario

The interface to all broker backends technology is generic. One would swap seamlessly to any broker technology:

from tesselite import pubsubFactory

# broker : gcp-pubsub
client_gcp = pubsubFactory(broker="gcp-pubsub")(topic="tesselite-pubsub", log_name="tesselite")

# broker : redis
client_redis = pubsubFactory(broker="redis")(topic="tesselite-pubsub", log_name="tesselite")

The connection to broker auto-heals when the broker backend is unavailable.

The generic mechanics bellow works for all broker backends:

  1. topic checkout
  2. topic creation
  3. subscription checkout
  4. subscription creation
  5. publish or consume

Pathologic Behaviors

A) Messages are lost if the subscription doesn't exist → This is an incurable limitation of pubsub mechanics.

B) The broker redis would drop messages if the consumer disconnects → This seems to be related to 'livestream' behavior of Redis.

C) The broker gcp-pubsub would freeze for a random timeperiod if no messages are available → This would generate sluggishness from time to time.

Therefore, the broker redis is ideal for livestreaming but not for message retention critical PaaS.

Therefore, the broker gcp-pubsub is ideal for message retention critical PaaS but maybe sluggish for livestream.

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

tesselite_pubsub-0.1.6.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tesselite_pubsub-0.1.6-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file tesselite_pubsub-0.1.6.tar.gz.

File metadata

  • Download URL: tesselite_pubsub-0.1.6.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for tesselite_pubsub-0.1.6.tar.gz
Algorithm Hash digest
SHA256 2d885a4a2b9cc40a3680bd17e6c9b2bb365978117ed7164e442c8bb9702122ec
MD5 f7d2dddac6e436791d3c25e31c52c471
BLAKE2b-256 0f3f391341f53686dbbba339227479e94b08e87b50055179be986f3a39d4a984

See more details on using hashes here.

File details

Details for the file tesselite_pubsub-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: tesselite_pubsub-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for tesselite_pubsub-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4f37c761cde4c56168e97c7b669492d62cb0ae80913ff32e276adc25393cc39f
MD5 e54b3c62dc5fe71dcfccc894a9334d63
BLAKE2b-256 72cff7427fe59be95d745337c83971695e56a88f422cc83e0e8f4fd5f596f6ee

See more details on using hashes here.

Supported by

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