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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_pubsub-0.0.4.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.4.tar.gz
Algorithm Hash digest
SHA256 466f1d3f38da9b769589bd7a6d42d2304c22fe6f5db65e79235b2aa57f664783
MD5 f8c40dbb5eaff221e0719abc6c9cab1a
BLAKE2b-256 44ed6cba4105d58cd10975193903bd42128fb9ebe527b8bf8c509e21935dc583

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_pubsub-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cefc8a4ce467d7bfb8f915e38e57035d670d405529b632a92f9ee2de297f9af9
MD5 ee044185a815a90f2d0ea3129018120d
BLAKE2b-256 ccad9929ffd123756768a0e9cbf6658ccd1a7b81bde7f688556fed6019f2dd45

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