{ "info": { "author": "sinoroc", "author_email": "sinoroc.code+python@gmail.com", "bugtrack_url": null, "classifiers": [ "Framework :: Pyramid", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Internet :: WWW/HTTP", "Topic :: Software Development :: Libraries :: Application Frameworks", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "..\n\n\n.. contents::\n\n.. sectnum::\n\n\nIntroduction\n============\n\n**REST APIs documented and sensible**\n\nBuild automatically documented REST APIs with the `Pyramid framework`_.\n\nThis library is available on the Python package index under the project name\n``rapids``:\n\n* https://pypi.python.org/pypi/rapids\n\n* https://pypi.org/project/rapids/\n\n\nUsage\n=====\n\n.. code:: python\n\n @rapids.decorators.resource('', None)\n class Root(rapids.resources.Base):\n pass\n\n\n @pyramid.view.view_config(context=Root, rapids='')\n def root_view(resource, request):\n return pyramid.httpexceptions.HTTPNotFound()\n\n\n @rapids.decorators.resource('foo', Root)\n class Foo(rapids.resources.Base):\n pass\n\n\n @pyramid.view.view_defaults(context=Foo, rapids='')\n class FooView:\n def __init__(self, resource, request):\n pass\n\n @pyramid.view.view_config(request_method='GET')\n def _get_view(self):\n return pyramid.httpexceptions.HTTPOk()\n\n @pyramid.view.view_config(request_method='POST')\n def _post_view(self):\n return pyramid.httpexceptions.HTTPCreated()\n\n\nHacking\n=======\n\nThis project makes extensive use of `tox`_, `pytest`_, and `GNU Make`_.\n\n\nDevelopment environment\n-----------------------\n\nUse following command to create a Python virtual environment with all\nnecessary dependencies::\n\n tox --recreate -e develop\n\nThis creates a Python virtual environment in the ``.tox/develop`` directory. It\ncan be activated with the following command::\n\n . .tox/develop/bin/activate\n\n\nRun test suite\n--------------\n\nIn a Python virtual environment run the following command::\n\n make review\n\nOutside of a Python virtual environment run the following command::\n\n tox --recreate\n\n\nBuild and package\n-----------------\n\nIn a Python virtual environment run the following command::\n\n make package\n\nOutside of a Python virtual environment run the following command::\n\n tox --recreate -e package\n\n\n.. Links\n\n.. _`GNU Make`: https://www.gnu.org/software/make/\n.. _`Pyramid framework`: https://trypyramid.com/\n.. _`pytest`: http://pytest.org/\n.. _`tox`: https://tox.readthedocs.io/\n\n\n.. EOF\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/sinoroc/rapids", "keywords": "", "license": "Apache-2.0", "maintainer": "", "maintainer_email": "", "name": "rapids", "package_url": "https://pypi.org/project/rapids/", "platform": "", "project_url": "https://pypi.org/project/rapids/", "project_urls": { "Homepage": "https://github.com/sinoroc/rapids" }, "release_url": "https://pypi.org/project/rapids/0.0.1/", "requires_dist": [ "PyYAML", "pyramid", "setuptools", "venusian", "zope.interface" ], "requires_python": "", "summary": "REST APIs documented and sensible", "version": "0.0.1" }, "last_serial": 3390519, "releases": { "0.0.0": [ { "comment_text": "", "digests": { "md5": "3251767c7f19885a34cb1b4eec3a1996", "sha256": "6f9b301d12094959cff1b63dd1d4fea69dadb13f5ad33e628d18ee53d80ee7bb" }, "downloads": -1, "filename": "rapids-0.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "3251767c7f19885a34cb1b4eec3a1996", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9737, "upload_time": "2017-12-03T18:42:42", "url": "https://files.pythonhosted.org/packages/85/87/f1ea905420adb582a509da0363bdb9a3ae4145e25fbcbcd522d0fc359368/rapids-0.0.0-py3-none-any.whl" } ], "0.0.1": [ { "comment_text": "", "digests": { "md5": "fd6870bdcf56b362c720299f9adee721", "sha256": "fd614eae1478bea845b357e03473d87e17665c38547ee774b22ddf0c1922c4e0" }, "downloads": -1, "filename": "rapids-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "fd6870bdcf56b362c720299f9adee721", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10247, "upload_time": "2017-12-05T13:02:14", "url": "https://files.pythonhosted.org/packages/e1/51/1c8cbc90cbf1778699d0f9be280c84fac8058dcfc1da20d9976489cbae69/rapids-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "545c08c38bfe09c0725a411aa43399ed", "sha256": "a2a98d9a52aea3039603bb822382755ac418bb68612a12404a9d5fedc8d66edf" }, "downloads": -1, "filename": "rapids-0.0.1.tar.gz", "has_sig": false, "md5_digest": "545c08c38bfe09c0725a411aa43399ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10490, "upload_time": "2017-12-05T13:02:16", "url": "https://files.pythonhosted.org/packages/7f/f1/9d14fbd8978e0155562d03e14126e90ac6ac9705c276f4b45fd36a013027/rapids-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fd6870bdcf56b362c720299f9adee721", "sha256": "fd614eae1478bea845b357e03473d87e17665c38547ee774b22ddf0c1922c4e0" }, "downloads": -1, "filename": "rapids-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "fd6870bdcf56b362c720299f9adee721", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 10247, "upload_time": "2017-12-05T13:02:14", "url": "https://files.pythonhosted.org/packages/e1/51/1c8cbc90cbf1778699d0f9be280c84fac8058dcfc1da20d9976489cbae69/rapids-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "545c08c38bfe09c0725a411aa43399ed", "sha256": "a2a98d9a52aea3039603bb822382755ac418bb68612a12404a9d5fedc8d66edf" }, "downloads": -1, "filename": "rapids-0.0.1.tar.gz", "has_sig": false, "md5_digest": "545c08c38bfe09c0725a411aa43399ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10490, "upload_time": "2017-12-05T13:02:16", "url": "https://files.pythonhosted.org/packages/7f/f1/9d14fbd8978e0155562d03e14126e90ac6ac9705c276f4b45fd36a013027/rapids-0.0.1.tar.gz" } ] }