{
"info": {
"author": "Krzysztof Jagiello",
"author_email": "me@kjagiello.com",
"bugtrack_url": null,
"classifiers": [
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Topic :: Internet"
],
"description": ".. image:: http://i.imgur.com/CgGL5eU.png\n------\n\n.. image:: https://badge.fury.io/py/thunderpush.png\n\t:target: http://badge.fury.io/py/thunderpush\n\n.. image:: https://secure.travis-ci.org/thunderpush/thunderpush.png?branch=master\n\t:target: http://travis-ci.org/thunderpush/thunderpush\n\nThunderpush is a Tornado and SockJS based push service. It provides\na Beaconpush (beaconpush.com) inspired HTTP API and client.\n\nInstall\n=======\n\n::\n\n\tpip install thunderpush\n\nUsage\n=====\n\n::\n\n\tusage: thunderpush [-h] [-p PORT] [-H HOST] [-v] [-d] [-V] clientkey apikey\n\n\tpositional arguments:\n\t clientkey client key\n\t apikey server API key\n\n\toptional arguments:\n\t -h, --help show this help message and exit\n\t -p PORT, --port PORT binds server to custom port\n\t -H HOST, --host HOST binds server to custom address\n\t -v, --verbose verbose mode\n\t -d, --debug debug mode (useful for development)\n\t -V, --version show program's version number and exit\n\nJavaScript client\n=================\n\nIn order to use provided by Thunderpush client, you need to include following\nlines on your webpage.\n\n::\n\n\t\n\t\n\nThe only thing you have to do now is to make a connection to your Thunderpush\nserver in following way::\n\n\t\n\nThis code is all you need to do to start receive messages pushed to the client\nfrom your Thunderpush server. As you can see, we instructed Thunder client\nto display logs, which can be helpful for debugging your application.\n\nFor more examples of how to use Thunderpush, look into `examples `_.\n\nOpen-source libraries for communicating with the HTTP API\n=========================================================\n\nPython: `python-thunderclient `_\n\nPHP: `php-thunderclient `_\n\nJava: `java-thunderclient `_\n\nHubot: `hubot-thunderpush `_\n\nRuby: `thunderpush-gem `_\n\n.NET: `ThunderClient.Net `_\n\nUsing the HTTP API\n==================\n\nExample of interacting with Thunderpush API using cURL::\n\n\tcurl \\\n\t\t-X POST \\\n\t\t-H \"Content-Type: application/json\" \\\n\t\t-H \"X-Thunder-Secret-Key: secretkey\" \\\n\t\t--data-ascii \"\\\"Hello World!\\\"\" \\\n\t\thttp://thunder.example.com/api/1.0.0/[API key]/channels/[channel]/\n\nAll requests to the HTTP API must provide *X-Thunder-Secret-Key* header that\nshould contain the private API key.\n\nSending a message to a channel\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n\tPOST /api/1.0.0/[API key]/channels/[channel]/\n\nMessage should be sent as the body of the request. Only valid JSON body\nwill be accepted.\n\nGetting number of users online\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n\tGET /api/1.0.0/[API key]/users/\n\nChecking presence of a user\n^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n\tGET /api/1.0.0/[API key]/users/[user id]/\n\nSending a message to a user\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n\tPOST /api/1.0.0/[API key]/users/[user id]/\n\nMessage should be sent as the body of the request. Only valid JSON body\nwill be accepted.\n\nForcing logout of a user\n^^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n\tDELETE /api/1.0.0/[API key]/users/[user id]/\n\nAlways returns 204 http code.\n\nRetrieving list of users in a channel\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n\tGET /api/1.0.0/[API key]/channels/[channel]/\n\nJavaScript client API\n=====================\n\nConnecting to the server\n^^^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n\tThunder.connect(server, apiKey, channels, options)\n\nConnects to the Thunderpush server and starts listening for incomming\nmessages.\n\nserver\n Adress of your Thunderpush server.\n\napiKey\n Public api key.\n\nchannels\n Array of channels you want to subscribe to.\n\noptions\n Object with optional settings you may pass to Thunder:\n\n log\n\tSet it to true if you want to activate verbose mode. This will turn on\n\tSockJS logs as well.\n\n user\n\tSet it to override the client generated user id.\n\n\tprotocol\n\tSet it to \"https\" if you want to use it instead of \"http\".\n\nListening for messages\n^^^^^^^^^^^^^^^^^^^^^^\n\n::\n\n\tThunder.listen(handler)\n\nRegisters callback function that will receive incomming messages. You can\nregister as many handlers you want. Handler function should accept\none argument which is the message itself.\n\nGetting high CPU usage?\n^^^^^^^^^^^^^^^^^^^^^^^\n\nBefore giving up on thunderpush, check it's logs and look for\nerrors like this one `error: [Errno 24] Too many open files`. If you're seeing them,\nit means that you've reached the limit of open file descriptors on your system.\nThe only thing you need to do is to raise the limit. Following SO answer will\ntell you how to do it: http://stackoverflow.com/a/4578356/250162 Then simply\nrestart thunderpush, forget about the problem and get a cold one!\n",
"description_content_type": null,
"docs_url": null,
"download_url": "UNKNOWN",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/thunderpush/thunderpush",
"keywords": null,
"license": "BSD",
"maintainer": null,
"maintainer_email": null,
"name": "thunderpush",
"package_url": "https://pypi.org/project/thunderpush/",
"platform": "UNKNOWN",
"project_url": "https://pypi.org/project/thunderpush/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/thunderpush/thunderpush"
},
"release_url": "https://pypi.org/project/thunderpush/1.0.1/",
"requires_dist": null,
"requires_python": null,
"summary": "Tornado and SockJS based, complete Web push solution.",
"version": "1.0.1"
},
"last_serial": 3351944,
"releases": {
"0.9.1": [],
"0.9.2": [],
"0.9.3": [
{
"comment_text": "",
"digests": {
"md5": "de57942a16edd6912238c79b85e06545",
"sha256": "70d117b713cb055e0d9fb7b03812868361649e4c1b2e646c96739ad46eb5f9de"
},
"downloads": -1,
"filename": "thunderpush-0.9.3.tar.gz",
"has_sig": false,
"md5_digest": "de57942a16edd6912238c79b85e06545",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8198,
"upload_time": "2012-08-20T09:15:23",
"url": "https://files.pythonhosted.org/packages/18/57/34c6c53eee186fd765222e26e8c66c078cb6d9d8e5749fffdc7142af363c/thunderpush-0.9.3.tar.gz"
}
],
"0.9.4": [
{
"comment_text": "",
"digests": {
"md5": "2bf9bc4f088d93a4a3e481ec870ae031",
"sha256": "526083d18354871b3b3932deed04bbfb14201b743aea37083296d8efc495c6ca"
},
"downloads": -1,
"filename": "thunderpush-0.9.4.tar.gz",
"has_sig": false,
"md5_digest": "2bf9bc4f088d93a4a3e481ec870ae031",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9129,
"upload_time": "2012-08-20T13:18:00",
"url": "https://files.pythonhosted.org/packages/fb/6b/9373ec1b262c88ca84de5a0308b30ca607c0ca686985f31fb7d2df6cb539/thunderpush-0.9.4.tar.gz"
}
],
"0.9.5": [
{
"comment_text": "",
"digests": {
"md5": "bee34b7dd6e19f00d7d6012d4a9dbe12",
"sha256": "9551abdd935eb9d2196d05f1f1dcd691f737d031af5f2de31eb44918c09816a6"
},
"downloads": -1,
"filename": "thunderpush-0.9.5.tar.gz",
"has_sig": false,
"md5_digest": "bee34b7dd6e19f00d7d6012d4a9dbe12",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9152,
"upload_time": "2012-08-21T11:00:19",
"url": "https://files.pythonhosted.org/packages/a7/89/ac151749b60d06909bb44fe644a33f134d2fba897f2b19e549c53dcfa079/thunderpush-0.9.5.tar.gz"
}
],
"0.9.6": [
{
"comment_text": "",
"digests": {
"md5": "c7b47a54cdabbb22c3eb00d9a5c26a55",
"sha256": "f533e734d72c37080339b7154320b56b1442c78ab7de36531348e4c94f1e088a"
},
"downloads": -1,
"filename": "thunderpush-0.9.6.tar.gz",
"has_sig": false,
"md5_digest": "c7b47a54cdabbb22c3eb00d9a5c26a55",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9547,
"upload_time": "2012-08-23T21:38:29",
"url": "https://files.pythonhosted.org/packages/73/ca/d96ea5245d22bc538d194a29e2b05e3831e19a637dac9b0ade9b35707fd6/thunderpush-0.9.6.tar.gz"
}
],
"0.9.7": [
{
"comment_text": "",
"digests": {
"md5": "d7e5b8f567e90ec72e4de9304ada0966",
"sha256": "590a96a4d2a69e3d09f0552940bab1462f79ec4c969899821a6c5541b48e6909"
},
"downloads": -1,
"filename": "thunderpush-0.9.7.tar.gz",
"has_sig": false,
"md5_digest": "d7e5b8f567e90ec72e4de9304ada0966",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10943,
"upload_time": "2012-08-24T11:49:29",
"url": "https://files.pythonhosted.org/packages/43/ec/307a808a7dbc515e36cdcc9dff95e6a29aff1e42fabf3303295b8f2c47d0/thunderpush-0.9.7.tar.gz"
}
],
"1.0.0": [
{
"comment_text": "",
"digests": {
"md5": "358dc268eed6cb67602d6bf7bcd2c38d",
"sha256": "89df2287ac0e49eb7450c3be59adf88d04fb9781c31d1f1dc6d03bec4eebd6ec"
},
"downloads": -1,
"filename": "thunderpush-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "358dc268eed6cb67602d6bf7bcd2c38d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16260,
"upload_time": "2015-10-14T19:28:19",
"url": "https://files.pythonhosted.org/packages/5a/f2/6db6692290ae16c79422d54c2eb81b3618e4f7f59e76484483679575a1d5/thunderpush-1.0.0.tar.gz"
}
],
"1.0.1": [
{
"comment_text": "",
"digests": {
"md5": "8a73f50242112d8f0774ad9ae81dcf7a",
"sha256": "f6ad02e8766d3b49cc760e738b5880ce59d48cfedefe3263d06fb736c1326e15"
},
"downloads": -1,
"filename": "thunderpush-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8a73f50242112d8f0774ad9ae81dcf7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16612,
"upload_time": "2016-04-20T15:04:07",
"url": "https://files.pythonhosted.org/packages/f1/e5/4ac4722f073ef51f4590aac1c06bd90845f8ce0f270ba77e3c38e1f2c304/thunderpush-1.0.1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "8a73f50242112d8f0774ad9ae81dcf7a",
"sha256": "f6ad02e8766d3b49cc760e738b5880ce59d48cfedefe3263d06fb736c1326e15"
},
"downloads": -1,
"filename": "thunderpush-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8a73f50242112d8f0774ad9ae81dcf7a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16612,
"upload_time": "2016-04-20T15:04:07",
"url": "https://files.pythonhosted.org/packages/f1/e5/4ac4722f073ef51f4590aac1c06bd90845f8ce0f270ba77e3c38e1f2c304/thunderpush-1.0.1.tar.gz"
}
]
}