Skip to main content

A simple but yet elegant publish/subscribe socket implementation using FastAPI Websocket.

Project description

FastAPI Pub/Sub

A simple but yet elegant publish/subscribe socket implementation using FastAPI Websocket.

Installation

pip install fastapi-pubsub

How it works

FastAPI provides an awesome implementation of Websockets. But it can be painful to configure it to work as a publish/subscribe mechanism.

FastAPI Pub/Sub implemented a BaseWebSocket that handles all client's connections under the hood. All you have to do is extend this class, overriding the method generate_object_to_send(self) with your desired logic.

A minimun example of a server/client communication can be seen here. Follow the instructions to see it working.

Contributing

Despite being full functional, this project is in a very early stage. Pull requests are very welcome!

In my opinion, a good next step here is to implement some in-memory database to store connections at connection_manager. For now, it uses a dictionary to handle it.

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

fastapi_pubsub-0.0.7.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

fastapi_pubsub-0.0.7-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_pubsub-0.0.7.tar.gz.

File metadata

  • Download URL: fastapi_pubsub-0.0.7.tar.gz
  • Upload date:
  • Size: 2.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for fastapi_pubsub-0.0.7.tar.gz
Algorithm Hash digest
SHA256 7d53fba1f992140bebe9ac4c993842f2948a1bd365b9ce82cb67184401559c7f
MD5 a09a1821fd976acdb44f93e381ce9d74
BLAKE2b-256 d8a0cfcdadc3407e4e5967fb83d624ff2429afaca383f763cc8e1740e6ff6b3e

See more details on using hashes here.

File details

Details for the file fastapi_pubsub-0.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_pubsub-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 203ca6085b959431a2122910d839018b5189eaeddbc18befa79ff7f17ac2d81b
MD5 48b1d055aecd32c7f49506c2dad8d91d
BLAKE2b-256 50152c6f6d351bf32b22ac571cae73d3b6fae041198b83798868b908950a1fa7

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