{ "info": { "author": "Anirban Roy Das", "author_email": "anirban.nick@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: Implementation :: CPython" ], "description": "========================\nsockjsChat\n========================\n\nA sockJS based Chat-Server/Chat-System primary using the SockJS protocol.\n\n-------\nDetails\n-------\n\n:Author: Anirban Roy Das\n:Email: anirban.nick@gmail.com\n:Copyright(C): 2016, Anirban Roy Das \n\nCheck sockjsChat/LICENSE file for full Copyright notice.\n\n--------\nOverview\n--------\n\nsockjsChat is a very basic Chat Server which can be set up locally to chat in your LAN. It supports both **Public Chat** among all participants connected simultaneously at a particulartime and also **Private Chat** between those individual participants.\n\nIt uses the **sockjs** protocol to implement the real time message passing system. **SockJS** is implemented in many languages, primarily javascript to talk to servers in real time using its protocol, which tries to create a duplex bi-directional connectin between the **Client(browser)** and the **Server**. The server should also implement the **sockjs** protocol. Thus, using the **sockjs-tornado** library which exposes the **sockjs** protocol in **tornado** server. It first tries to create a **Websocket** connection, and if it fails then it fallbacks to other transport mechanisms, such as **ajax**, **long polling**, etc.\n\nYou can read more about **sockjs** `here `_\n\n---------------\nTechnical Specs\n---------------\n\n:sockjs-client: Advance Websocket Javascript Client\n:Tornado: async python web server\n:sockjs-tornado: sockjs websocket server implementation for Tornado\n\n\n \n------------\nInstallation\n------------\n\n\nPrerequisites\n`````````````\n\n1. python 2.7+\n2. tornado\n3. sockjs-tornado\n4. sockjs-client\n\n\nInstall\n```````\n\n::\n \n pip install sockjsChat\n\nIf the above dependencies do not get installed by the above command, then use the below steps to install them one by one.\n\n **Step 1 - Install pip**\n \n Follow the below methods for installing pip. One of them may help you to install pip in your system.\n\n * **Method 1 -** https://pip.pypa.io/en/stable/installing/\n * **Method 2 -** http://ask.xmodulo.com/install-pip-linux.html\n * **Method 3 -** If you installed python on MAC OS X via ``brew install python``, then pip is already installed along with python.\n\n\n **Step 2 - Install tornado**\n ::\n\n pip install tornado \n \n\n **Step 3 - Install sockjs-tornado**\n ::\n\n pip install sockjs-tornado\n \n------ \nUsage\n------\n\nAfter having installed sockjsChat, just run the following command to use it :\n\n* **Start Server**\n ::\n \n $ sockjsChat [options]\n\n\n\n* **Options**\n \n :--port: Port number where the chat server will start\n\n* **Example**\n ::\n\n $ sockjsChat --port=8765\n\n\n* **Stop Server**\n \n Click ``Ctrl+C`` to stop the server.\n\n\n----\nTODO\n----\n\n1. Add Private Chat functionality.\n2. Manage Presence Management, sent, delivered acknowledgements.\n3. Message Persistence and delivery of messages to offline clients.\n4. Add Blog post regarding this topic.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/anirbanroydas/sockjsChat", "keywords": "chat server sockjs websocket tornado", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sockjsChat", "package_url": "https://pypi.org/project/sockjsChat/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/sockjsChat/", "project_urls": { "Homepage": "https://github.com/anirbanroydas/sockjsChat" }, "release_url": "https://pypi.org/project/sockjsChat/1.1.0/", "requires_dist": [ "setuptools (>=0.7.0)", "sockjs-tornado", "tornado (>=2.2.1)" ], "requires_python": "", "summary": "A Chat Server based on sockjs, websocket and tornado", "version": "1.1.0" }, "last_serial": 2105325, "releases": { "1.1.0": [ { "comment_text": "", "digests": { "md5": "643777ad2e9437c33e2cf066547b0be0", "sha256": "8778fe140f81528b661d268f5d78326e766cfa8ffaefed489711193a09bf1afb" }, "downloads": -1, "filename": "sockjsChat-1.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "643777ad2e9437c33e2cf066547b0be0", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 28529, "upload_time": "2016-05-08T18:19:11", "url": "https://files.pythonhosted.org/packages/a3/fa/041aa0759a4887bf4d59143648eb715725c9a68137d708447d17599f3333/sockjsChat-1.1.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c1473618366dda1178af9997673b7f62", "sha256": "adaf649ad3ef6e83509e5abc584d8db7a559e3a89ae5d1aae7133bc3eee29c7e" }, "downloads": -1, "filename": "sockjsChat-1.1.0.tar.gz", "has_sig": false, "md5_digest": "c1473618366dda1178af9997673b7f62", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26294, "upload_time": "2016-05-08T18:19:18", "url": "https://files.pythonhosted.org/packages/00/a9/98b82e23bf2a55a577ae888123a8754713f3ea61592cf20317af6d3437c2/sockjsChat-1.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "643777ad2e9437c33e2cf066547b0be0", "sha256": "8778fe140f81528b661d268f5d78326e766cfa8ffaefed489711193a09bf1afb" }, "downloads": -1, "filename": "sockjsChat-1.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "643777ad2e9437c33e2cf066547b0be0", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 28529, "upload_time": "2016-05-08T18:19:11", "url": "https://files.pythonhosted.org/packages/a3/fa/041aa0759a4887bf4d59143648eb715725c9a68137d708447d17599f3333/sockjsChat-1.1.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c1473618366dda1178af9997673b7f62", "sha256": "adaf649ad3ef6e83509e5abc584d8db7a559e3a89ae5d1aae7133bc3eee29c7e" }, "downloads": -1, "filename": "sockjsChat-1.1.0.tar.gz", "has_sig": false, "md5_digest": "c1473618366dda1178af9997673b7f62", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26294, "upload_time": "2016-05-08T18:19:18", "url": "https://files.pythonhosted.org/packages/00/a9/98b82e23bf2a55a577ae888123a8754713f3ea61592cf20317af6d3437c2/sockjsChat-1.1.0.tar.gz" } ] }