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.

Instalation

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 process(self, client) 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.5.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_pubsub-0.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 fa0b4e9d3a0ead7a1927a7bf62c6869d93b8f28e324fa444eabcc336bc730dc2
MD5 675a4a0a8014bb2dae4a0aa229eaf1ec
BLAKE2b-256 880678c862e6b555739a41611498f93b579329cdbb0b57ebf6cae01f78f60b33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_pubsub-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 39b4358f0db12047a0fc88c3c5f3bad129c5c3d7cf7b4ae13a1aed44be76d678
MD5 013e83508de1393ae71f97baef0ee9e4
BLAKE2b-256 cb107e46fc1cf4cf58314e95f25fea2549cc6c70e644476b6f1b86488eefa9b2

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