{ "info": { "author": "Marc Abramowitz", "author_email": "johna@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "tomb_reflect\n=================================\n\n.. image:: https://img.shields.io/pypi/v/tomb_reflect.svg\n :target: https://pypi.python.org/pypi/tomb_reflect\n\n.. image:: https://img.shields.io/travis/tomborine/tomb_reflect.svg\n :target: https://travis-ci.org/tomborine/tomb_reflect\n\n.. image:: https://coveralls.io/repos/tomborine/tomb_reflect/badge.png?branch=master\n :target: https://coveralls.io/r/tomborine/tomb_reflect?branch=master\n\nIntro\n=================================\n\nEasily make your Pyramid-powered Web API introspectable.\n\nAll it takes is:\n\n.. code-block:: python\n\n config.include('tomb_reflect', route_prefix='/api_info')\n\n # You could pass options to tomb_reflect_add_views to add auth, etc.\n config.tomb_reflect_add_views()\n\nWith this, your app now responds to 2 new URLs.\n\nThe first URL, ``/api_info/routes``, returns a list of routes:\n\n.. code-block:: json\n\n {\n \"hello\": {\n \"route_pattern\": \"/hello\"\n },\n \"hello_name\": {\n \"route_pattern\": \"/hello_name/{name}\"\n },\n \"tomb_reflect.routes#index\": {\n \"route_pattern\": \"api_info/routes\"\n },\n \"tomb_reflect.routes#show\": {\n \"route_pattern\": \"api_info/routes/{route_name}\"\n }\n }\n\nThe second URL, ``/api_info/routes/{route_name}``, returns detailed info for a\nspecific route:\n\n.. code-block:: json\n\n {\n \"route_name\": \"hello\",\n \"route_pattern\": \"/hello\",\n \"view\": \"inventorysvc.views.hello.hello\"\n }\n\n\nConfiguration\n=================================\n\nIf you want the URLs to be under a different root path, change the\n``route_prefix`` in your ``config.include`` call:\n\n.. code-block:: python\n\n config.include('tomb_reflect', route_prefix='/super/secret/place')\n\nIf you want the URLs to only be visible with certain permissions, require\nspecial authorization, etc., you can pass options to\n``config.tomb_reflect_add_views``:\n\n.. code-block:: python\n\n # You can pass options to tomb_reflect_add_views to add auth, etc.\n config.tomb_reflect_add_views(\n decorator=SomeCustomDecorator,\n permission='reflect')\n\n\nSimilar\n=================================\n\n- pyramid-describe_ - Only works for apps that use pyramid-controller_ dispatch though\n\n\n.. _Pyramid: http://www.trypyramid.com/\n.. _pyramid-describe: https://pypi.python.org/pypi/pyramid_describe\n.. _pyramid-controller: https://pypi.python.org/pypi/pyramid_controllers", "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/msabramo/tomb_reflect", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "tomb_reflect", "package_url": "https://pypi.org/project/tomb_reflect/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/tomb_reflect/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/msabramo/tomb_reflect" }, "release_url": "https://pypi.org/project/tomb_reflect/0.0.1/", "requires_dist": null, "requires_python": null, "summary": "Add API to introspect routes for your Pyramid web app", "version": "0.0.1" }, "last_serial": 1385600, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "4129ae33d870400fec212b6ba67dec25", "sha256": "829bb8e1accd078618c1c42917c59c607ad379fad75acc406ea35d137efb04bf" }, "downloads": -1, "filename": "tomb_reflect-0.0.1.tar.gz", "has_sig": false, "md5_digest": "4129ae33d870400fec212b6ba67dec25", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4913, "upload_time": "2015-01-17T00:43:59", "url": "https://files.pythonhosted.org/packages/ee/02/cb46ceeb2f5fd333ca61cd2059a7096baf3618a87c75c1eb17808eed6689/tomb_reflect-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4129ae33d870400fec212b6ba67dec25", "sha256": "829bb8e1accd078618c1c42917c59c607ad379fad75acc406ea35d137efb04bf" }, "downloads": -1, "filename": "tomb_reflect-0.0.1.tar.gz", "has_sig": false, "md5_digest": "4129ae33d870400fec212b6ba67dec25", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4913, "upload_time": "2015-01-17T00:43:59", "url": "https://files.pythonhosted.org/packages/ee/02/cb46ceeb2f5fd333ca61cd2059a7096baf3618a87c75c1eb17808eed6689/tomb_reflect-0.0.1.tar.gz" } ] }