{ "info": { "author": "Sreejith Kesavan", "author_email": "sreejithemk@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "Framework :: Flask", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: POSIX", "Programming Language :: Python", "Topic :: Internet", "Topic :: Internet :: WWW/HTTP", "Topic :: Utilities" ], "description": "wsnotifier\n==========\n\n`Build Status `__\n\nwsnotifier is a lightweight `gevent `__ based\nasynchronous websocket Server written in Python. wsnotifier exposes HTTP\nAPIs for forwarding the messages to the websocket clients. This makes it\neasier to use the service with any web application. It\u2019s completely\nwritten in Python and doesn\u2019t depend on external systems like Redis for\nstoring/retrieving messages.\n\n`wsnotifier components `__\n\nInstallation\n------------\n\nYou can install using ``pip``\n\n::\n\n $ pip install git+https://github.com/semk/wsnotifier.git\n\nOr using docker\n\n::\n\n $ docker pull semk/wsnotifier\n\nRunning wsnotifier server\n-------------------------\n\n::\n\n $ wsnotifier\n Starting wsnotifier on ws://0.0.0.0:1729/alerts and http://0.0.0.0:1729/alerts\n\nOr using docker\n\n::\n\n $ docker run -p 1729:1729 --rm -it semk/wsnotifier\n Starting wsnotifier on ws://0.0.0.0:1729/alerts and http://0.0.0.0:1729/alerts\n\nConnecting to wsnotifier via a websocket client\n-----------------------------------------------\n\n``wscat`` is a nice commandline websocket client. You can install it by\n\n::\n\n $ npm install -g wscat\n\nConnect to the websocket server at ``ws://0.0.0.0:1729/alerts``\n\n::\n\n $ wscat -c ws://localhost:1729/alerts\n connected (press CTRL+C to quit)\n\nPosting messages to wsnotifier for forwarding to websocket clients.\n-------------------------------------------------------------------\n\nYou can use any HTTP client to send the messages. This will be forwarded\nto all the connected websocket clients asynchronously. A Python client\nfor wsnotifier is available `here `__\n\n::\n\n $ curl -X POST -H \"Content-Type: application/json\" -d '{\"id\": \"unique-message-id\", \"type\": \"important\", \"message\": \"important message\"}' http://0.0.0.0:1729/alerts\n {\"status\": \"success\"}\n\nYou can see the forwarded message appearing on the ``wscat`` client\ninstantly.\n\n::\n\n $ wscat -c ws://localhost:1729/alerts\n connected (press CTRL+C to quit)\n < {\"message\": \"important message\", \"type\": \"important\", \"id\": \"unique-message-id\"}\n >", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "websocket http ws server", "license": "", "maintainer": "", "maintainer_email": "", "name": "wsnotifier", "package_url": "https://pypi.org/project/wsnotifier/", "platform": "any", "project_url": "https://pypi.org/project/wsnotifier/", "project_urls": null, "release_url": "https://pypi.org/project/wsnotifier/1.0.4/", "requires_dist": null, "requires_python": "", "summary": "Gevent based Asynchronous WebSocket Server with HTTP APIs.", "version": "1.0.4" }, "last_serial": 3943590, "releases": { "1.0.4": [ { "comment_text": "", "digests": { "md5": "36b491fe17a8cc3269086e74c2eaa892", "sha256": "8ccd513a71e508337c6f6bd4b6850907d541f054bd59dcec146528d8ecdb145a" }, "downloads": -1, "filename": "wsnotifier-1.0.4.tar.gz", "has_sig": false, "md5_digest": "36b491fe17a8cc3269086e74c2eaa892", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5978, "upload_time": "2018-06-08T17:48:22", "url": "https://files.pythonhosted.org/packages/56/37/7d73763ba752f2a30aa13dcbe096db31ce35f48afc5efb4b72db0920f871/wsnotifier-1.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "36b491fe17a8cc3269086e74c2eaa892", "sha256": "8ccd513a71e508337c6f6bd4b6850907d541f054bd59dcec146528d8ecdb145a" }, "downloads": -1, "filename": "wsnotifier-1.0.4.tar.gz", "has_sig": false, "md5_digest": "36b491fe17a8cc3269086e74c2eaa892", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5978, "upload_time": "2018-06-08T17:48:22", "url": "https://files.pythonhosted.org/packages/56/37/7d73763ba752f2a30aa13dcbe096db31ce35f48afc5efb4b72db0920f871/wsnotifier-1.0.4.tar.gz" } ] }