{ "info": { "author": "Charles Flynn", "author_email": "git@irab.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "Eve-docs\n========\n\nA blueprint that generates documentation for\n`Eve `__ APIs in HTML and JSON\nformats. Eve-docs creates the documentation from your existing Eve\nconfiguration file, with no additional configuration required.\n\nInstallation\n~~~~~~~~~~~~\n\nClone this repo into your Eve application and modify your launch script\nto activate the blueprints:\n\n::\n\n from flask.ext.bootstrap import Bootstrap\n from eve_docs import eve_docs\n ...\n Bootstrap(app)\n app.register_blueprint(eve_docs, url_prefix='/docs')\n\nAfter restarting, documentation is availabile at the ``url_prefix``\ndefined in your launch script. ``example.py`` shows how to do this using\nthe launch script from Nicola Iarocci's\n`eve-demo `__ repo.\n\nHTML output\n~~~~~~~~~~~\n\nThe HTML documentation is produced using the\n`Flask-Bootstrap `__ blueprint.\nExpand each domain to show available endpoint methods, and further\nexpand each method to show parameter details. A screenshot with one\nmethod expanded follows, and you can also view a `fully expanded\nexample `__. |Sample\noutput|\n\nJSON output\n~~~~~~~~~~~\n\nDocumentation is also exposed as JSON at ``url_prefix/spec.json`` for\nprogrammatic consumption. Example output:\n\n::\n\n {\n \"base\": \"http://localhost:5000\",\n \"domains\": {\n \"people\": {\n \"/people/{_id}\": {\n \"GET\": {\n \"label\": \"Retrieve a person\",\n \"params\": [\n {\n \"name\": \"_id\",\n \"type\": \"string\",\n \"required\": true\n }\n ]\n ...\n\nLicense\n~~~~~~~\n\nReleased under the `MIT\nLicense `__.\n\n.. |Sample output| image:: http://charonex.com/img/evedocs-example.png", "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/charlesflynn/eve-docs", "keywords": null, "license": "The MIT License\n\nCopyright (c) 2013 Charles Flynn \n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.", "maintainer": null, "maintainer_email": null, "name": "Eve-docs", "package_url": "https://pypi.org/project/Eve-docs/", "platform": "any", "project_url": "https://pypi.org/project/Eve-docs/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/charlesflynn/eve-docs" }, "release_url": "https://pypi.org/project/Eve-docs/0.1.4/", "requires_dist": null, "requires_python": null, "summary": "Generates documentation for Eve APIs", "version": "0.1.4" }, "last_serial": 1084827, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "d3c94d479b992d32ef3d101cd86852cf", "sha256": "9848de35c55fc517e1afdfc0ed974bffe3a1cbd6b2f56a7f3e69cc075514579f" }, "downloads": -1, "filename": "Eve-docs-0.1.0.tar.gz", "has_sig": false, "md5_digest": "d3c94d479b992d32ef3d101cd86852cf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5508, "upload_time": "2014-04-23T11:31:56", "url": "https://files.pythonhosted.org/packages/dc/b0/ac29853adabffeb0d392547a687324bc8906c206bdcdb3e1269df8054a39/Eve-docs-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "5c675bc7e3ea09451f208ac1aaa204e1", "sha256": "5f197ef5cd1d7e3f1c67dc84d04a3e96b7b7f10473268e2c5ad48e4809765c14" }, "downloads": -1, "filename": "Eve-docs-0.1.1.tar.gz", "has_sig": false, "md5_digest": "5c675bc7e3ea09451f208ac1aaa204e1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5553, "upload_time": "2014-04-23T11:48:45", "url": "https://files.pythonhosted.org/packages/cb/6c/d668f74f1265502e1e4fea6990be40157728d0abc8281ca3dd4fe99ecb3d/Eve-docs-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "6440781b8bd4c33aea70e01a0c2392b5", "sha256": "14e6e380d45ad63f6f3a1492c9dadd0927ddda1803bc8f9c997263d58f674baf" }, "downloads": -1, "filename": "Eve-docs-0.1.2.tar.gz", "has_sig": false, "md5_digest": "6440781b8bd4c33aea70e01a0c2392b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5566, "upload_time": "2014-05-04T23:43:51", "url": "https://files.pythonhosted.org/packages/ab/c7/2f332b246b6f17665f423b774a1d2617485add2e11bdc7da6324da1dd02c/Eve-docs-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "1fa9e0f070639154d4871e2bea478f94", "sha256": "425af2ed6ff6ff6d73825306095e2b0e5056c39054a3728460533ec8739d14d8" }, "downloads": -1, "filename": "Eve-docs-0.1.3.tar.gz", "has_sig": false, "md5_digest": "1fa9e0f070639154d4871e2bea478f94", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5764, "upload_time": "2014-05-08T00:36:38", "url": "https://files.pythonhosted.org/packages/a5/f0/8965481b19e9f8c7788315db458cde3680207bd8f81070eeff4a3cce7c61/Eve-docs-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "88e38dc20940951e13735c54fc50e76c", "sha256": "235110db2af061c1f0d068a6dcf97a8e5c63a8672740bee7389bbf2cdbd6d997" }, "downloads": -1, "filename": "Eve-docs-0.1.4.tar.gz", "has_sig": false, "md5_digest": "88e38dc20940951e13735c54fc50e76c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5827, "upload_time": "2014-05-07T01:29:15", "url": "https://files.pythonhosted.org/packages/b6/9a/d977b5d7d36424cf6f5bdb71cb4ac274336cc3d69a1aad42a22e68d4fcb1/Eve-docs-0.1.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "88e38dc20940951e13735c54fc50e76c", "sha256": "235110db2af061c1f0d068a6dcf97a8e5c63a8672740bee7389bbf2cdbd6d997" }, "downloads": -1, "filename": "Eve-docs-0.1.4.tar.gz", "has_sig": false, "md5_digest": "88e38dc20940951e13735c54fc50e76c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5827, "upload_time": "2014-05-07T01:29:15", "url": "https://files.pythonhosted.org/packages/b6/9a/d977b5d7d36424cf6f5bdb71cb4ac274336cc3d69a1aad42a22e68d4fcb1/Eve-docs-0.1.4.tar.gz" } ] }