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.6.tar.gz (2.7 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_pubsub-0.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 5299be10ba66c1dae071f611688c27830bbba462347bb5437e2d7fd2092d8899
MD5 731b2acf0aa6d0cd3b96720ab46b63dc
BLAKE2b-256 64159ad6ea739fc6e6b995a70fea14debf42c2ac11c102a115cf86e0873cbac4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_pubsub-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 035d9103d7d6de10417548560b0a9715be5141b4eabb82703eb423d8cc6d24f9
MD5 bc39dd0d93698ecf00448d0c6d759149
BLAKE2b-256 5b6a88cf58e48593f4867b3f19c41924dc11b4cb5cd4cc5ceb82ae85473c8fd9

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