{ "info": { "author": "Brian Rue", "author_email": "brian@ratchet.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Web Environment", "Framework :: Pyramid", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP", "Topic :: Software Development", "Topic :: Software Development :: Bug Tracking", "Topic :: Software Development :: Quality Assurance", "Topic :: Software Development :: Testing" ], "description": "pyratchet\n=========\n\npyratchet is a generic library for reporting exceptions and other messages to Ratchet.io_::\n\n import ratchet, sys\n ratchet.init('YOUR_ACCESS_TOKEN', 'production') # access_token, environment\n\n try:\n main_app_loop()\n except IOError:\n ratchet.report_message('Got an IOError in the main loop', 'warning')\n except:\n # catch-all\n ratchet.report_exc_info(sys.exc_info())\n\n\nRequirements\n------------\npyratchet requires:\n\n- Python 2.6 or 2.7\n- requests 0.12+\n- a Ratchet.io account\n\n\nInstallation\n------------\nInstall using pip::\n \n pip install ratchet\n\n\nConfiguration\n-------------\n**For generic Python or a non-Django/non-Pyramid framework, follow these instructions:**\n\nSomewhere in your initialization code, call ratchet.init() with your access_token::\n\n ratchet.init('YOUR_ACCESS_TOKEN_HERE', environment='production')\n\nOther options can be passed as keyword arguments. See the reference below for all options.\n\n**If you are integrating with Django, follow these instructions:**\n\n1. In your ``settings.py``, add ``'ratchet.contrib.django.middleware.RatchetNotifierMiddleware'`` as the last item in ``MIDDLEWARE_CLASSES``::\n\n MIDDLEWARE_CLASSES = (\n # ... other middleware classes ...\n 'ratchet.contrib.django.middleware.RatchetNotifierMiddleware',\n )\n\n2. Add these configuration variables in ``settings.py``::\n\n RATCHET = {\n 'access_token': 'YOUR_ACCESS_TOKEN_HERE',\n 'environment': 'development' if DEBUG else 'production',\n 'branch': 'master',\n 'root': '/absolute/path/to/code/root',\n }\n\n**If you are integrating with Pyramid, follow these instructions:**\n\n1. In your ``ini`` file (e.g. ``production.ini``), add ``ratchet.contrib.pyramid`` to the end of your ``pyramid.includes``::\n \n [app:main]\n pyramid.includes =\n pyramid_debugtoolbar\n ratchet.contrib.pyramid\n \n2. Add these ratchet configuration variables::\n \n [app:main]\n ratchet.access_token = YOUR_ACCESS_TOKEN_HERE\n ratchet.environment = production\n ratchet.branch = master\n ratchet.root = %(here)s\n\nThe above will configure ratchet to catch and report all exceptions that occur in your Pyramid app. However, if there are any middleware\napplications that wrap your app, Ratchet will not be able to catch exceptions. \n\nIn order to catch exceptions from Pyramid and middleware code, you will need to create a ``pipeline`` where the ratchet middleware wraps your Pyramid app.\n\n- Change your ``ini`` file to use a ``pipeline``::\n\n From\n\n [app:main]\n ...\n\n To\n\n [pipeline:main]\n pipeline =\n ratchet\n YOUR_APP_NAME\n\n [app:YOUR_APP_NAME]\n pyramid.includes =\n pyramid_debugtoolbar\n ratchet.contrib.pyramid\n\n [filter:ratchet]\n access_token = YOUR_ACCESS_TOKEN_HERE\n environment = production\n branch = master\n root = %(here)s\n\n\nUnfortunately, the ratchet tween and the ratchet filter configurations contains duplicated information. We'll look into fixing this in future versions.\n\nUsage\n-----\nThe Django and Pyramid integration will automatically report uncaught exceptions to Ratchet.\n\nCall ``ratchet.report_exc_info()`` to report an exception, or ``ratchet.report_message()`` to report an arbitrary string message. See the docstrings for more info.\n\n\nConfiguration reference\n-----------------------\n\naccess_token\n Access token from your Ratchet.io project\nhandler\n One of:\n\n - blocking -- runs in main thread\n - thread -- spawns a new thread\n - agent -- writes messages to a log file for consumption by ratchet-agent\n\n **default:** ``thread``\nenvironment\n Environment name. Any string up to 255 chars is OK. For best results, use \"production\" for your production environment.\nroot\n Absolute path to the root of your application, not including the final ``/``. \nbranch\n Name of the checked-out branch.\n\n **default:** ``master``\nagent.log_file\n If ``handler`` is ``agent``, the path to the log file. Filename must end in ``.ratchet``\nendpoint\n URL items are posted to.\n \n **default:** ``https://submit.ratchet.io/api/1/item/``\nscrub_fields\n List of field names to scrub out of POST. Values will be replaced with astrickses. If overridiing, make sure to list all fields you want to scrub, not just fields you want to add to the default. Param names are converted to lowercase before comparing against the scrub list.\n\n **default** ``['passwd', 'password', 'secret', 'confirm_password', 'password_confirmation']``\n\n\nDeveloper Resources\n-------------------\nGet in touch! We'd love to hear what you think and we're happy to help.\n\n- Email us: ``support@ratchet.io``\n- IRC: ``#ratchet.io`` on ``irc.freenode.net``\n- Want to contribute? Send a pull request at https://github.com/ratchetio/pyratchet\n\n\n.. _Ratchet.io: http://ratchet.io/\n.. _error tracking: http://ratchet.io/", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/ratchetio/pyratchet", "keywords": null, "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "ratchet", "package_url": "https://pypi.org/project/ratchet/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/ratchet/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/ratchetio/pyratchet" }, "release_url": "https://pypi.org/project/ratchet/0.4.1/", "requires_dist": null, "requires_python": null, "summary": "Ratchet.io generic python library", "version": "0.4.1" }, "last_serial": 798550, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "60ed426c29e772c41947a285984ab68d", "sha256": "3d03cde4d0d1a736da7e804165b9e6813875f8bc8b06d5dd8fcd19fbf5940194" }, "downloads": -1, "filename": "ratchet-0.1.0.tar.gz", "has_sig": false, "md5_digest": "60ed426c29e772c41947a285984ab68d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2019, "upload_time": "2012-08-09T00:57:59", "url": "https://files.pythonhosted.org/packages/b2/21/511ccdeb53d218ae071e614b9852cb2ab29867bf358399b39938492c3f54/ratchet-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "5383fd7af064b2939b2c845d44b51e3e", "sha256": "32b989548ccaf56308deaef55118281886e721c2c27164e50204e7d6dc67895a" }, "downloads": -1, "filename": "ratchet-0.1.1.tar.gz", "has_sig": false, "md5_digest": "5383fd7af064b2939b2c845d44b51e3e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4110, "upload_time": "2012-08-09T01:06:19", "url": "https://files.pythonhosted.org/packages/05/26/40754d8f8abc11c26309b2574d355abd1fe10f925ed34f36b3dc0b71a90e/ratchet-0.1.1.tar.gz" } ], "0.1.10": [ { "comment_text": "", "digests": { "md5": "28f289d1d2cda1a5c509df0dde071145", "sha256": "410b3cb40f0cca0af59ac83a0c4fa8ba12e0d01774beffac29a7a939c8aef19a" }, "downloads": -1, "filename": "ratchet-0.1.10.tar.gz", "has_sig": false, "md5_digest": "28f289d1d2cda1a5c509df0dde071145", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5999, "upload_time": "2012-11-15T00:14:34", "url": "https://files.pythonhosted.org/packages/0f/5d/461e2b7e7d58bd71a3776cb235131713b684b600b0edfe58ed7a70722c3c/ratchet-0.1.10.tar.gz" } ], "0.1.11": [ { "comment_text": "", "digests": { "md5": "a6e68f2cc92ba20e9a6397cd90d7f866", "sha256": "e9f2ca88543837afd0323dec43c0d7c245b4db5132596593b313088e595f6b3a" }, "downloads": -1, "filename": "ratchet-0.1.11.tar.gz", "has_sig": false, "md5_digest": "a6e68f2cc92ba20e9a6397cd90d7f866", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6463, "upload_time": "2012-11-30T23:22:44", "url": "https://files.pythonhosted.org/packages/9e/1d/f8b6445871184d4d20964cdf45dafae502b3f97a974a61dab6bdd939425d/ratchet-0.1.11.tar.gz" } ], "0.1.12": [ { "comment_text": "", "digests": { "md5": "5b4086fce6612d4ae09f92f92ab8e303", "sha256": "2ae8eee29aa993c2abe83215886bb681383f517b1ce76c04934e75e9ef482231" }, "downloads": -1, "filename": "ratchet-0.1.12.tar.gz", "has_sig": false, "md5_digest": "5b4086fce6612d4ae09f92f92ab8e303", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6559, "upload_time": "2012-12-03T21:06:28", "url": "https://files.pythonhosted.org/packages/a4/80/e1e574da251ccdcf518c877e4ed4fd341ff43ecc0843548bbd800ce6aa71/ratchet-0.1.12.tar.gz" } ], "0.1.13": [ { "comment_text": "", "digests": { "md5": "5cd766abaea62077622bba38db719dc1", "sha256": "a52a9c36c7561fc575ce0a1df3c3b2882e52e669f32b128a44452eb5b8c863a6" }, "downloads": -1, "filename": "ratchet-0.1.13.tar.gz", "has_sig": false, "md5_digest": "5cd766abaea62077622bba38db719dc1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6563, "upload_time": "2012-12-04T03:37:35", "url": "https://files.pythonhosted.org/packages/b9/d0/ef56583a56a3cf042e9c6529201c0788cac43c5b7964fa95b8bb71217b8d/ratchet-0.1.13.tar.gz" } ], "0.1.14": [ { "comment_text": "", "digests": { "md5": "ce33382f2e7d811a375b98dd768e0ebc", "sha256": "05d0412165238a4079c2979ad7a82dd6d539fcdcf0e7f3e61c0392c796be277b" }, "downloads": -1, "filename": "ratchet-0.1.14.tar.gz", "has_sig": false, "md5_digest": "ce33382f2e7d811a375b98dd768e0ebc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6754, "upload_time": "2012-12-04T05:27:14", "url": "https://files.pythonhosted.org/packages/13/19/794771fad2ea9ba5f7a5f474c4e62ce51ed1a8fa7624cb5d5e7d16a74c13/ratchet-0.1.14.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "4b93d631aaad8ecf23d3f2757661fd6f", "sha256": "ff8e78d9f790fa791bb21b5ff777517ea48175bce28abf081053e8a9755c00c2" }, "downloads": -1, "filename": "ratchet-0.1.2.tar.gz", "has_sig": false, "md5_digest": "4b93d631aaad8ecf23d3f2757661fd6f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4079, "upload_time": "2012-08-09T01:16:25", "url": "https://files.pythonhosted.org/packages/57/37/68fe718de14051228315ac9b717ced2a25fdfc70034d647f440e46b35132/ratchet-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "3e0e6f366a5639a370210cc4be205c46", "sha256": "ed145ddfa4fa710e7c7756a70b855de22fa055b21ab45ae18f3b8a6be59f1f53" }, "downloads": -1, "filename": "ratchet-0.1.3.tar.gz", "has_sig": false, "md5_digest": "3e0e6f366a5639a370210cc4be205c46", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4329, "upload_time": "2012-08-09T20:07:27", "url": "https://files.pythonhosted.org/packages/a6/dc/095ffe6cc05b48cbdd56200b160e10b9ea6638ac4420d3979d2d366fa060/ratchet-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "40cc01dca3fe892372bec9b94a481ce5", "sha256": "78ac430b7417273392adde01b802274132dca3e05ac9578bbfcb75cd27c9f0e8" }, "downloads": -1, "filename": "ratchet-0.1.4.tar.gz", "has_sig": false, "md5_digest": "40cc01dca3fe892372bec9b94a481ce5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4327, "upload_time": "2012-08-12T23:22:05", "url": "https://files.pythonhosted.org/packages/cb/8d/6bab8f4866b374b45c971049654c8c22c86bc65185d4fab26d082398a800/ratchet-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "229d0928ea0ca2a252dbb9258a0dc118", "sha256": "89d1b22a8c3a3eec4b75cae0db4dab7422d338e945e24927d7a5a1fc73be35a7" }, "downloads": -1, "filename": "ratchet-0.1.5.tar.gz", "has_sig": false, "md5_digest": "229d0928ea0ca2a252dbb9258a0dc118", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4434, "upload_time": "2012-10-13T20:27:48", "url": "https://files.pythonhosted.org/packages/20/d0/d7bb8c41ca50e1d0664c5d6bc95833f4e3832f95f2920191957eec60f7fe/ratchet-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "e7195eea6ed39d6239c25e42162cd20b", "sha256": "844d583a8fe65df9e1d01540cb02b85b4b1d0d563fe26d775655efc25b3b2f5c" }, "downloads": -1, "filename": "ratchet-0.1.6.tar.gz", "has_sig": false, "md5_digest": "e7195eea6ed39d6239c25e42162cd20b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5356, "upload_time": "2012-10-23T06:03:25", "url": "https://files.pythonhosted.org/packages/5f/b6/74287099f506976c22a414838b4ff25b242144e89e204d7a69524ee10f66/ratchet-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "6f16e549b0b94348006e9c0be42fe33d", "sha256": "17466ae54df98035574d1f5cdc2a7bb4b093b9666469b764435531ffa7c2fd89" }, "downloads": -1, "filename": "ratchet-0.1.7.tar.gz", "has_sig": false, "md5_digest": "6f16e549b0b94348006e9c0be42fe33d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5417, "upload_time": "2012-10-24T20:07:44", "url": "https://files.pythonhosted.org/packages/dd/ac/0ce63e51e799a621044ec39014d0b3bb4bc55ebcc1c407f6ce9b4093d8c9/ratchet-0.1.7.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "54c816c0e46822f81a3aefc514acf4db", "sha256": "0727021a292ae8a691a9820258ddb0f6e96feac02388a6653226a55af9b9aecd" }, "downloads": -1, "filename": "ratchet-0.1.9.tar.gz", "has_sig": false, "md5_digest": "54c816c0e46822f81a3aefc514acf4db", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5883, "upload_time": "2012-11-03T00:49:13", "url": "https://files.pythonhosted.org/packages/0f/8b/c83aaa3cf115938f903e7f8f3e933a149cc54782226ee2e3431127a3f41c/ratchet-0.1.9.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "f1e78f4f6787ad357bbddb9ab08081c1", "sha256": "1d95e846d66896792b0b7e6ed6118da02599b5fbb559ba4b1dd2ddb47465ab87" }, "downloads": -1, "filename": "ratchet-0.2.0.tar.gz", "has_sig": false, "md5_digest": "f1e78f4f6787ad357bbddb9ab08081c1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7126, "upload_time": "2012-12-04T17:35:28", "url": "https://files.pythonhosted.org/packages/5e/91/5bbd1e6fee12a9014f78057bdd50ea7f7f4d67fcf26238ab8e5e0f252ef5/ratchet-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "082a9eee5c0e507b8db04c3b3b0ea029", "sha256": "ae4a3f30860121bfcce33a452e8b5bec76c989bd947348931e13f6c913bcbdcf" }, "downloads": -1, "filename": "ratchet-0.2.1.tar.gz", "has_sig": false, "md5_digest": "082a9eee5c0e507b8db04c3b3b0ea029", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7108, "upload_time": "2012-12-04T17:51:41", "url": "https://files.pythonhosted.org/packages/a0/27/3a9631aa6410f305715c36c6bd51f7a83dea738ef2469e798eeb36858b9f/ratchet-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "65c9019e50e2c13ba16d5aa6f95ccdf4", "sha256": "b5d10556ee6e16af4e2bc96ba5a5dee23156e649d0539acdea06e16fbcc5f602" }, "downloads": -1, "filename": "ratchet-0.3.0.tar.gz", "has_sig": false, "md5_digest": "65c9019e50e2c13ba16d5aa6f95ccdf4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8041, "upload_time": "2013-01-10T23:41:23", "url": "https://files.pythonhosted.org/packages/08/ec/a7c6cdeb248d6ccb30a71d6fbb067ae8f809e4be50c2598699179716e1ff/ratchet-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "ea4993a8965ec7e3581224ee29a1e3df", "sha256": "a4d432ae9687e42446affd7e2be9a8f5a72fb85625860422df764302e9227ca6" }, "downloads": -1, "filename": "ratchet-0.3.1.tar.gz", "has_sig": false, "md5_digest": "ea4993a8965ec7e3581224ee29a1e3df", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10545, "upload_time": "2013-01-11T08:23:52", "url": "https://files.pythonhosted.org/packages/bb/c6/575a0a951c81c21339874a4f3822ad068d73c679749f7c731448f56463ff/ratchet-0.3.1.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "55b0c2d6763307f1676c0687b3c52689", "sha256": "e544132fc5f933285cbcf152bb18974e3e199a3777d586af093cf666e7637804" }, "downloads": -1, "filename": "ratchet-0.3.2.tar.gz", "has_sig": false, "md5_digest": "55b0c2d6763307f1676c0687b3c52689", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12269, "upload_time": "2013-01-24T02:47:27", "url": "https://files.pythonhosted.org/packages/6a/01/3fbd0b5e6d23341b38e8770022c20bac9edf9e7d5da413264ed0298268e8/ratchet-0.3.2.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "4fc573deaf430a6ef9db6a39b5067f60", "sha256": "b1206f5908d6ee8ffd69ca37a21edf6c2c5d7f86fcb3e4fc3dd66c3af9b3110a" }, "downloads": -1, "filename": "ratchet-0.4.0.tar.gz", "has_sig": false, "md5_digest": "4fc573deaf430a6ef9db6a39b5067f60", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11163, "upload_time": "2013-02-13T01:34:57", "url": "https://files.pythonhosted.org/packages/8a/b2/066970e0afe3d9dd5ef3009afa0d261b49db771a46ccaa845a423845dcdb/ratchet-0.4.0.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "26328827aa36bf3e8d87f928b8f37a64", "sha256": "cc81934adef120a10573611dccfd7b49607ae519f92ef9511e3611d2126f1efb" }, "downloads": -1, "filename": "ratchet-0.4.1.tar.gz", "has_sig": false, "md5_digest": "26328827aa36bf3e8d87f928b8f37a64", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11335, "upload_time": "2013-02-20T21:43:09", "url": "https://files.pythonhosted.org/packages/89/e8/e25f60eef4a2a13cd58bbf2019ca527a1f1afa61dcebe7e68db950cb231f/ratchet-0.4.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "26328827aa36bf3e8d87f928b8f37a64", "sha256": "cc81934adef120a10573611dccfd7b49607ae519f92ef9511e3611d2126f1efb" }, "downloads": -1, "filename": "ratchet-0.4.1.tar.gz", "has_sig": false, "md5_digest": "26328827aa36bf3e8d87f928b8f37a64", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11335, "upload_time": "2013-02-20T21:43:09", "url": "https://files.pythonhosted.org/packages/89/e8/e25f60eef4a2a13cd58bbf2019ca527a1f1afa61dcebe7e68db950cb231f/ratchet-0.4.1.tar.gz" } ] }