https://github.com/laxertu/eric-api

A ready-to-use SSE messaging microservice implementation
https://github.com/laxertu/eric-api

api-rest fastapi queues sse sse-server

Last synced: 10 months ago
JSON representation

A ready-to-use SSE messaging microservice implementation

• Host: GitHub
• URL: https://github.com/laxertu/eric-api
• Owner: laxertu
• License: mit
• Created: 2024-09-14T15:55:14.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2025-09-04T09:13:44.000Z (10 months ago)
• Last Synced: 2025-09-04T10:37:20.594Z (10 months ago)
• Topics: api-rest, fastapi, queues, sse, sse-server
• Language: Python
• Homepage:
• Size: 149 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
A ready-to-use SSE messaging microservice implementation.

Backend documentation https://laxertu.github.io/eric/docs.html  

REST services rely on FastApi + Uvicorn

Features:

* channel subscription

* broadcasting

* message deliver to one client

* SSE compliant streaming

**Installation:**

    pip install eric-api

**Start webserver**

    uvicorn eric_api:app

**Docker stuff**

[Here](https://github.com/laxertu/eric-api/tree/master/docker) you can find a couple of prefabs for redis and api itself

Services exposed are

http://127.0.0.1:5540/ Redis Insights. Host to use when creating dbs have to be "redis", as per service definition

http://127.0.0.1:8000/docs Swagger

**Redis persistence support**   

Activate it by creating a .eric-api.env with the following:

    QUEUES_FACTORY=redis

Redis host is configured by  

    REDIS_HOST=[host to use]

    REDIS_PORT=[port]

    REDIS_DB=[db number]

API documentation is available at http://127.0.0.1:8000/docs by default

See correspondant uvicorn configuration https://www.uvicorn.org/deployment/#running-from-the-command-line 

Bug Tracker: https://github.com/laxertu/eric-api/issues