{
    "info": {
        "author": "UNKNOWN",
        "author_email": "UNKNOWN",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "****************************************\nHIPOCHAT: Websocket chat server\n****************************************\n\nSupports notifications and keep the old messages\n\nHipochat is an open-source websocket chat server, using RabbitMQ as message queue, Tornado as Backend Server and\nRedis for persistent data.\n\nKeeps the notifications count and also supports injections from external server directly to websocket\nSupports checking authentication with your own webserver.\n\n\nHow it works\n======================================================\n\nFirst clone the project\n\n**git clone https://github.com/Hipo/hipochat.git**\n\n\nThen install the requirements\n\n**pip install -r requirements.txt**\n\n\nMake sure that you have redis-server and rabbitmq servers are running\nSet your variables in \n\nvars.py::\n\n    PushNotificationURL = '<ENDPOINT RECEIVES YOUR PUSH NOTIFICATION SIGNAL AND SEND AN PN>'\n    ProfileURL = '<ENDPOINT YOU CAN ASK IF USER IS AUTHENTICATED>'\n    RABBIT_URL = '<RABBITMQ SERVER>'\n    RABBIT_USERNAME = '<RABBITMQ USERNAME>'\n    RABBIT_PASS = '<RABBITMQ PASSWORD>'\n    REDIS_URL = '<REDIS_URL>'\n\n\nYou can check the nginx reverse proxy details\n\nTechnical Detail\n===================================================\n\nChat Server Endpoint\n---------------------\n\nYour backend server needs an EP that you should be able to create a chat room or receive the chat room tokens\n\n\nExample request::\n\n    HEADER: Authentication: Token <Token>\n    URLs: **/api/chat**\n\nExample response::\n\n    {\n        \"chat\": {\n            \"token\": \"e598c2a9-317a-4577-8cbd-7fd5f0cddbdf\"\n        }\n    }\n\n\nIf room is created you should receive '201 CREATED' MESSAGE else if exists '200 OK'\n200 OK means you already have this chat room and you should fetch the old messages\n\n\nReceive the old messages\n-----------------------------------------\n\nYou visit the url with parameters below\n\n\nExample Request::\n\n    HEADER -> Authorization: Token <token>\n    HTTP GET **/talk/old/<chat_room_token>/**\n\n\nResponse::\n\n    HTTP 200 OK\n\n    {\n    oldy: [\n            {\n                timestamp: 1414768486.196569,\n                message: \"asdasda\",\n                author: \"asdasda\"\n            },\n            {\n                timestamp: 1414770934.580683,\n                message: \"adsadsdasads\",\n                author: \"assaddsa\"\n            },\n            {\n                timestamp: 1414772188.836509,\n                message: \"dsadasads\",\n                author: \"dssdaasd\"\n            },\n            {\n                timestamp: 1414773038.058612,\n                token: \"ac9e8485-8120-4cdc-a5c7-2687a04f01b5\",\n                injected: {\n                       message: \"hede\",\n                       hodo: \"hede\"\n                }\n            }\n          ]\n    }\n\n\n\nAs an authenticated user you can post injections to CHAT server\n------------------------------------------------\n\nYou can inject external messages from a Backend Server directly into Websocket\n\nExample Request::\n\n    HEADER -> Authorization: Token <token>\n    HTTP POST **/talk/item/<chat_room_token>/**\n\n    {   message: \"foobar\",\n        user: \"johndoe\"\n    }\n\n\nStart the Live Chat Server\n--------------------------------------------------------\n\nChat Server works with websocket technology\nAlso you will see the injections in chat dialogue when an injection comes directly to Chat Server\nYou should pass the user authentication token as query parameter\n\nExample Request::\n\n    WEBSOCKET\n    ws://server.url/talk/chat/<chat_token>/?token=<auth_token>\n\n\nNOTIFICATIONS COUNT\n-----------------------------------------------------\n\nYou can receive the notifications count of chat rooms for authenticated user\nby sending a request like below\n\n    HTTP GET **/talk/notification/<chat_token>/?type=<type>**\n\nGot some of the code from https://github.com/haridas/RabbitChat\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "UNKNOWN",
        "keywords": null,
        "license": "UNKNOWN",
        "maintainer": null,
        "maintainer_email": null,
        "name": "hipochat",
        "package_url": "https://pypi.org/project/hipochat/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/hipochat/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "UNKNOWN"
        },
        "release_url": "https://pypi.org/project/hipochat/0.1/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "UNKNOWN",
        "version": "0.1"
    },
    "last_serial": 1447953,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "137c6aabd5627e597ba4e6b6a8b1827c",
                    "sha256": "4c635fb6573f5c70ff772dbd7f76f4f74ed02b1e832d43eb7656df5a0684bcff"
                },
                "downloads": -1,
                "filename": "hipochat-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "137c6aabd5627e597ba4e6b6a8b1827c",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6398,
                "upload_time": "2015-03-04T16:35:40",
                "url": "https://files.pythonhosted.org/packages/d1/f0/65011f280e29932a65073017562e795454e06c2510063d7c5ac08526f62d/hipochat-0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "137c6aabd5627e597ba4e6b6a8b1827c",
                "sha256": "4c635fb6573f5c70ff772dbd7f76f4f74ed02b1e832d43eb7656df5a0684bcff"
            },
            "downloads": -1,
            "filename": "hipochat-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "137c6aabd5627e597ba4e6b6a8b1827c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6398,
            "upload_time": "2015-03-04T16:35:40",
            "url": "https://files.pythonhosted.org/packages/d1/f0/65011f280e29932a65073017562e795454e06c2510063d7c5ac08526f62d/hipochat-0.1.tar.gz"
        }
    ]
}