eric-api


Nameeric-api JSON
Version 1.6.0.8 PyPI version JSON
download
home_pagehttps://github.com/laxertu/eric-api
SummaryA Server sent events based messaging microservice implementation
upload_time2025-09-07 20:26:16
maintainerNone
docs_urlNone
authorLuca Stretti
requires_python<3.12,>=3.10
licenseMIT
keywords sse api rest server sent events microservice messaging
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/laxertu/eric-api",
    "name": "eric-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.12,>=3.10",
    "maintainer_email": null,
    "keywords": "sse, api, rest, server sent events, microservice, messaging",
    "author": "Luca Stretti",
    "author_email": "laxertu@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b5/1c/d894e39612466f8ed54b36f497111ae14fdae2c3ca0fab98b5fa05bad70a/eric_api-1.6.0.8.tar.gz",
    "platform": null,
    "description": "A ready-to-use SSE messaging microservice implementation.\n\nBackend documentation https://laxertu.github.io/eric/docs.html  \nREST services rely on FastApi + Uvicorn\n\nFeatures:\n* channel subscription\n* broadcasting\n* message deliver to one client\n* SSE compliant streaming\n\n**Installation:**\n\n    pip install eric-api\n\n**Start webserver**\n\n    uvicorn eric_api:app\n\n**Docker stuff**\n\n[Here](https://github.com/laxertu/eric-api/tree/master/docker) you can find a couple of prefabs for redis and api itself\n\nServices exposed are\n\nhttp://127.0.0.1:5540/ Redis Insights. Host to use when creating dbs have to be \"redis\", as per service definition\nhttp://127.0.0.1:8000/docs Swagger\n\n\n\n\n**Redis persistence support**   \n\nActivate it by creating a .eric-api.env with the following:\n\n    QUEUES_FACTORY=redis\n\nRedis host is configured by  \n\n    REDIS_HOST=[host to use]\n    REDIS_PORT=[port]\n    REDIS_DB=[db number]\n\nAPI documentation is available at http://127.0.0.1:8000/docs by default\n\nSee correspondant uvicorn configuration https://www.uvicorn.org/deployment/#running-from-the-command-line \n\nBug Tracker: https://github.com/laxertu/eric-api/issues\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Server sent events based messaging microservice implementation",
    "version": "1.6.0.8",
    "project_urls": {
        "Homepage": "https://github.com/laxertu/eric-api",
        "Issues": "https://github.com/laxertu/eric-api/issues",
        "Repository": "https://github.com/laxertu/eric-api"
    },
    "split_keywords": [
        "sse",
        " api",
        " rest",
        " server sent events",
        " microservice",
        " messaging"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "55ba341e5c390fcbe14fdf3266889409a671e4194a245b915377c6d765de2daa",
                "md5": "121b1283f6b68da7fb5a076745562dfd",
                "sha256": "399863026a34fa8f4239d59674ef02e2070e5ff34735081f1df225e824300633"
            },
            "downloads": -1,
            "filename": "eric_api-1.6.0.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "121b1283f6b68da7fb5a076745562dfd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.10",
            "size": 4358,
            "upload_time": "2025-09-07T20:26:14",
            "upload_time_iso_8601": "2025-09-07T20:26:14.994548Z",
            "url": "https://files.pythonhosted.org/packages/55/ba/341e5c390fcbe14fdf3266889409a671e4194a245b915377c6d765de2daa/eric_api-1.6.0.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b51cd894e39612466f8ed54b36f497111ae14fdae2c3ca0fab98b5fa05bad70a",
                "md5": "f8022eec3955cad3f329892f400d700a",
                "sha256": "cf1e6851e5cd97ecc3fa47369f8877e17e3141a60305fe18ce35599219135197"
            },
            "downloads": -1,
            "filename": "eric_api-1.6.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "f8022eec3955cad3f329892f400d700a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.10",
            "size": 3769,
            "upload_time": "2025-09-07T20:26:16",
            "upload_time_iso_8601": "2025-09-07T20:26:16.119397Z",
            "url": "https://files.pythonhosted.org/packages/b5/1c/d894e39612466f8ed54b36f497111ae14fdae2c3ca0fab98b5fa05bad70a/eric_api-1.6.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-07 20:26:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "laxertu",
    "github_project": "eric-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "eric-api"
}
        
Elapsed time: 1.31348s