{ "info": { "author": "Marcel Sander", "author_email": "marcel@actidoo.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Programming Language :: Python :: 3" ], "description": "Pyramid Swagger Specifier\n===============================\n\nversion number: 0.0.8\nauthor: Marcel Sander\n\nOverview\n--------\n\nDefines APIs, generates a Swagger specification, and validates inputs\n\nInstallation / Usage\n--------------------\n\nTo install use pip:\n\n $ pip install pyramid_swagger_spec\n\n\nOr clone the repo:\n\n $ git clone https://github.com/ActiDoo/pyramid_swagger_spec.git\n $ python setup.py install\n \nSetup the view-deriver and RouteRegistry in your configuration (\\_\\_init\\_\\_.py) by including\n\n```python\nconfig.include('pyramid_swagger_spec')\n```\n\nCreate an API namespace, e.g. in your routes.py:\n\n```python\nfrom pyramid_swagger_spec import create_api_namespace\napi_route = create_api_namespace(namespace=\"api\")\n```\n\nSetup the views. They return the swagger spec as json at /{namespace}/_swagger and as HTML at /{namespace}/_swagger.html.\n\n```python\nfrom pyramid_swagger_spec.swagger import create_swagger_view\ncreate_swagger_view(config, namespace=\"api\", title=\"Server Api\", version=\"0.1\")\n```\n\nTo specify API calls:\n \n```python\nimport pyramid_swagger_spec.swagger as sw\n# If you use traversal, the traversal hierarchy has to match the subpath (i.e. /api/echo must return an EchoRessource instance)\n# If you don't use traversal, do not pass a context and a name attribute\nfrom myproject.ressources import EchoRessource\nfrom myproject.routes import api_route\n \n \n@api_route(path=\"/echo/{x}\", request_method=\"GET\", name=\"test\", context=EchoRessource, renderer='json', api=sw.api(\n tag=\"default\",\n operation_id=\"echo_test\",\n summary=\"echos the input\",\n parameters=[\n sw.path_parameter(\"x\", sw.Types.number),\n sw.query_parameter(\"o\", sw.Types.number)\n ],\n responses={\n 200: sw.response(schema={\n \"status\": sw.property(sw.Types.string)\n })\n }\n))\ndef echo_test_view(request, *args, **kw):\n return {\n 'x': request.validated_params.path[\"x\"],\n 'o': request.validated_params.query[\"o\"],\n 'status': \"ok\"\n }\n```\n \nContributing\n------------\n\nEverything is welcome. For example tests, output validation, etc.\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/ActiDoo/pyramid_swagger_spec/tarball/0.0.11", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ActiDoo/pyramid_swagger_spec", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "pyramid_swagger_spec", "package_url": "https://pypi.org/project/pyramid_swagger_spec/", "platform": "", "project_url": "https://pypi.org/project/pyramid_swagger_spec/", "project_urls": { "Download": "https://github.com/ActiDoo/pyramid_swagger_spec/tarball/0.0.11", "Homepage": "https://github.com/ActiDoo/pyramid_swagger_spec" }, "release_url": "https://pypi.org/project/pyramid_swagger_spec/0.0.11/", "requires_dist": null, "requires_python": "", "summary": "Defines APIs, generates a Swagger specification, and validates inputs", "version": "0.0.11" }, "last_serial": 3741340, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "4d0714fe0edbdee6d7f59c3328ce4ca4", "sha256": "71e68d435fc2a7d0da09acbe230adb13d74dae85b2ef52639a1fc5896c738233" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.1.tar.gz", "has_sig": false, "md5_digest": "4d0714fe0edbdee6d7f59c3328ce4ca4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7023, "upload_time": "2017-02-09T11:43:29", "url": "https://files.pythonhosted.org/packages/7a/aa/5aeb42a250ed62f34e65fbd96c0f94a8f2aae3f08a0c319f79aa208ed4b3/pyramid_swagger_spec-0.0.1.tar.gz" } ], "0.0.10": [ { "comment_text": "", "digests": { "md5": "959e1b93ca345b9c70e8193c2e90c10e", "sha256": "de0539cd734dabe745884cb81ce1ddb0f1d63f452aad2acc1bde126d850d57c5" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.10.tar.gz", "has_sig": false, "md5_digest": "959e1b93ca345b9c70e8193c2e90c10e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8324, "upload_time": "2017-09-04T15:32:54", "url": "https://files.pythonhosted.org/packages/3b/5b/17304e77339eab387960d037265097797dcedf1f85bfcb9f4a9d9d844d9c/pyramid_swagger_spec-0.0.10.tar.gz" } ], "0.0.11": [ { "comment_text": "", "digests": { "md5": "ce7a124367c3a2dbeddb272d180da997", "sha256": "91c9a7c065cef07754426491caee698723ec33f782dd1dd4dc933050c463643e" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.11.tar.gz", "has_sig": false, "md5_digest": "ce7a124367c3a2dbeddb272d180da997", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8025, "upload_time": "2018-04-06T14:35:52", "url": "https://files.pythonhosted.org/packages/c5/87/48ee792742c7e4259f3762011757138bc6b3958c3b0cd49e6894d7b2ce82/pyramid_swagger_spec-0.0.11.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "4a4f90889733f47209f3da7daf2a4542", "sha256": "a06078b01e0ecbb9da6d0c42386dabd07cc29f960d8d03e60a2f1915a0a89086" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.2.tar.gz", "has_sig": false, "md5_digest": "4a4f90889733f47209f3da7daf2a4542", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7139, "upload_time": "2017-03-01T19:48:52", "url": "https://files.pythonhosted.org/packages/30/8d/ee3eaa01d42736b1f5c25eb3d36e33db7c21981530e2225f5098726d6b95/pyramid_swagger_spec-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "7653c4d06811b611ef0c51062ca97dd0", "sha256": "77c908af6c781e11660be717e03c901ac6db823d4cebcb4dc7674194694da3cd" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.3.tar.gz", "has_sig": false, "md5_digest": "7653c4d06811b611ef0c51062ca97dd0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7152, "upload_time": "2017-03-21T21:19:45", "url": "https://files.pythonhosted.org/packages/a4/a9/c6c4ec49059a6deec379393f0ee6272fb54ae9b328c30b8f701010b6b76a/pyramid_swagger_spec-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "721804246167130f552284b8cf86e679", "sha256": "a7492ec476754fe85a242a344cd6d2414a0c40d44411c253cd3d5972651d5791" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.4.tar.gz", "has_sig": false, "md5_digest": "721804246167130f552284b8cf86e679", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7312, "upload_time": "2017-03-29T15:04:52", "url": "https://files.pythonhosted.org/packages/37/ed/7fea0b856f8a82dabd80f3209d1367801eeff2911f0f4b6c99f9bfcd954f/pyramid_swagger_spec-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "3631d849aaa010b1762b4e6ce0d18f34", "sha256": "b408eb6648641f96660893479fa37fe8a924db2f8bf4d94c88b44a92218edfc2" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.5.tar.gz", "has_sig": false, "md5_digest": "3631d849aaa010b1762b4e6ce0d18f34", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8120, "upload_time": "2017-05-31T12:53:28", "url": "https://files.pythonhosted.org/packages/c5/0f/ca1005e28b63b71dab4a58a05dba325565cb94af7d65b1404440ec1b75ec/pyramid_swagger_spec-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "ac96b047272117143d636e134f5a8945", "sha256": "e38e41c8e2109996a97d1f844ff37b81a30b4a47d06e261d4e2cd3db552633dc" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.6.tar.gz", "has_sig": false, "md5_digest": "ac96b047272117143d636e134f5a8945", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7790, "upload_time": "2017-06-09T10:21:54", "url": "https://files.pythonhosted.org/packages/49/37/bd9605defd05326c61519310d1541881d2b1c87f4cf689060bf1e13ded3e/pyramid_swagger_spec-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "c0e4bdd12d89dbf0aa8d2c04aa834bea", "sha256": "671d5d9d119eaea9c1dcbe6564512138b8e7919d850c03851c3a8b3473188de6" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.7.tar.gz", "has_sig": false, "md5_digest": "c0e4bdd12d89dbf0aa8d2c04aa834bea", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8216, "upload_time": "2017-07-27T10:23:38", "url": "https://files.pythonhosted.org/packages/ad/8e/30f760adf285d10dd520c65de9fe4b50406683194b6b12c5c6124b6116cb/pyramid_swagger_spec-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "8c2bc6d3831cb2fbb3a9546153140e52", "sha256": "80a9692d792dd00ee3242023411dfaabf338ee438f9fe02e63581daeea5e4b19" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.8.tar.gz", "has_sig": false, "md5_digest": "8c2bc6d3831cb2fbb3a9546153140e52", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8251, "upload_time": "2017-08-04T10:12:04", "url": "https://files.pythonhosted.org/packages/15/e5/8feb67aa66de04334afbe90904405284e0c8a034cd7689497a4622a51f4b/pyramid_swagger_spec-0.0.8.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "ce7cc75160b60fdee9a0c07901ee51b3", "sha256": "e59f12b0888e0a04088955759ba10431d78379f581e689248c9f6bfdcab4f6d3" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.9.tar.gz", "has_sig": false, "md5_digest": "ce7cc75160b60fdee9a0c07901ee51b3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8281, "upload_time": "2017-09-04T13:24:59", "url": "https://files.pythonhosted.org/packages/d5/35/cb48c835ef5baaf6dec17837221ab0ce5fff87ab8e7a0bbe1016ef029181/pyramid_swagger_spec-0.0.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ce7a124367c3a2dbeddb272d180da997", "sha256": "91c9a7c065cef07754426491caee698723ec33f782dd1dd4dc933050c463643e" }, "downloads": -1, "filename": "pyramid_swagger_spec-0.0.11.tar.gz", "has_sig": false, "md5_digest": "ce7a124367c3a2dbeddb272d180da997", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8025, "upload_time": "2018-04-06T14:35:52", "url": "https://files.pythonhosted.org/packages/c5/87/48ee792742c7e4259f3762011757138bc6b3958c3b0cd49e6894d7b2ce82/pyramid_swagger_spec-0.0.11.tar.gz" } ] }