{ "info": { "author": "Steven Loria", "author_email": "sloria1@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "*********************\napispec-webframeworks\n*********************\n\n.. image:: https://badgen.net/pypi/v/apispec-webframeworks\n :target: https://pypi.org/project/apispec-webframeworks/\n :alt: PyPI version\n\n.. image:: https://dev.azure.com/sloria/sloria/_apis/build/status/marshmallow-code.apispec-webframeworks?branchName=master\n :target: https://dev.azure.com/sloria/sloria/_build/latest?definitionId=9&branchName=master\n :alt: Build status\n\n.. image:: https://badgen.net/badge/marshmallow/2,3?list=1\n :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html\n :alt: marshmallow 2/3 compatible\n\n.. image:: https://badgen.net/badge/code%20style/black/000\n :target: https://github.com/ambv/black\n :alt: code style: black\n\n`apispec `_ plugins for\nintegrating with various web frameworks.\n\nThese plugins used to be in ``apispec.ext`` but have since\nbeen moved to their own package.\n\n\nIncluded plugins:\n\n* ``apispec_webframeworks.bottle``\n* ``apispec_webframeworks.flask``\n* ``apispec_webframeworks.tornado``\n\nMigration from ``apispec<1.0.0``\n================================\n\nTo migrate from older versions of apispec, install this package\nwith\n\n.. code-block:: console\n\n pip install apispec-webframeworks\n\n\nChange your imports, like so:\n\n.. code-block:: python\n\n # apispec<1.0.0\n from apispec.ext.flask import FlaskPlugin\n\n # apispec>=1.0.0\n from apispec_webframeworks.flask import FlaskPlugin\n\nExample Usage\n=============\n\n.. code-block:: python\n\n from flask import Flask\n from apispec import APISpec\n from apispec.ext.marshmallow import MarshmallowPlugin\n from apispec_webframeworks.flask import FlaskPlugin\n from marshmallow import Schema, fields\n\n spec = APISpec(\n title=\"Gisty\",\n version=\"1.0.0\",\n info=dict(description=\"A minimal gist API\"),\n plugins=[FlaskPlugin(), MarshmallowPlugin()],\n )\n\n\n app = Flask(__name__)\n\n\n class GistParameter(Schema):\n gist_id = fields.Int()\n\n\n class GistSchema(Schema):\n id = fields.Int()\n content = fields.Str()\n\n\n @app.route(\"/gists/\")\n def gist_detail(gist_id):\n \"\"\"Gist detail view.\n ---\n get:\n parameters:\n - in: path\n schema: GistParameter\n responses:\n 200:\n schema: GistSchema\n \"\"\"\n return \"details about gist {}\".format(gist_id)\n\n\n # Since `path` inspects the view and its route,\n # we need to be in a Flask request context\n with app.test_request_context():\n spec.path(view=gist_detail)\n\nDocumentation\n=============\n\nFor documentation for a specific plugin, see its module docstring.\n\n\nDevelopment\n===========\n\n* Clone and cd into this repo\n* Create and activate a virtual environment\n* Install this package (in editable mode) and the development\n dependencies\n\n::\n\n $ pip install '.[dev]'\n\n* Install pre-commit hooks\n\n::\n\n $ pre-commit install\n\n\nRunning tests\n-------------\n\nTo run all tests: ::\n\n $ pytest\n\nTo run syntax checks: ::\n\n $ tox -e lint\n\n(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): ::\n\n $ tox\n\nLicense\n=======\n\nMIT licensed. See the bundled `LICENSE `_ file for more details.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/marshmallow-code/apispec-webframeworks", "keywords": "apispec,swagger,openapi,specification,documentation,spec,rest,api,web,flask,tornado,bottle,frameworks", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "apispec-webframeworks", "package_url": "https://pypi.org/project/apispec-webframeworks/", "platform": "", "project_url": "https://pypi.org/project/apispec-webframeworks/", "project_urls": { "Funding": "https://opencollective.com/marshmallow", "Homepage": "https://github.com/marshmallow-code/apispec-webframeworks", "Issues": "https://github.com/marshmallow-code/apispec-webframeworks/issues" }, "release_url": "https://pypi.org/project/apispec-webframeworks/0.5.0/", "requires_dist": [ "apispec[yaml] (>=2.0.0)", "pytest ; extra == 'dev'", "mock ; extra == 'dev'", "Flask (==1.1.1) ; extra == 'dev'", "tornado ; extra == 'dev'", "bottle (==0.12.17) ; extra == 'dev'", "flake8 (==3.7.8) ; extra == 'dev'", "flake8-bugbear (==19.8.0) ; extra == 'dev'", "pre-commit (~=1.18) ; extra == 'dev'", "tox ; extra == 'dev'", "flake8 (==3.7.8) ; extra == 'lint'", "flake8-bugbear (==19.8.0) ; extra == 'lint'", "pre-commit (~=1.18) ; extra == 'lint'", "pytest ; extra == 'tests'", "mock ; extra == 'tests'", "Flask (==1.1.1) ; extra == 'tests'", "tornado ; extra == 'tests'", "bottle (==0.12.17) ; extra == 'tests'" ], "requires_python": ">=3.6", "summary": "Web framework plugins for apispec.", "version": "0.5.0" }, "last_serial": 5855913, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "378ce127950c9b4deedcd8caefcdf38e", "sha256": "6e9f4f58a1b2ecb71077140aebeac3c0ef438eb77543cd66cf4e2efd040126e1" }, "downloads": -1, "filename": "apispec_webframeworks-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "378ce127950c9b4deedcd8caefcdf38e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7483, "upload_time": "2018-10-23T02:14:17", "url": "https://files.pythonhosted.org/packages/60/7e/ca734b40ef59d7aac6d13900bb50d8c99b3b52a79786dea6f1191802badf/apispec_webframeworks-0.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0b52f87139f0e64110bfe1b3240ae631", "sha256": "24e365a78aeabf9d0d3aa9d47b0edbd1853439143fac99affb48edd6c6417a95" }, "downloads": -1, "filename": "apispec-webframeworks-0.0.1.tar.gz", "has_sig": false, "md5_digest": "0b52f87139f0e64110bfe1b3240ae631", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5151, "upload_time": "2018-10-23T02:14:18", "url": "https://files.pythonhosted.org/packages/51/41/9d109e02a271a14131a5f6fd4508ff8d6d369b8ee0eaaa4184499eea1e9a/apispec-webframeworks-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "88bcfddd4fcdc9ac11ff7e8b333172e0", "sha256": "d05df725e76fb9a7804634359908d2f40dbc12efbaa13d5cd4d43f4c13f04173" }, "downloads": -1, "filename": "apispec_webframeworks-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "88bcfddd4fcdc9ac11ff7e8b333172e0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11395, "upload_time": "2018-10-23T21:58:27", "url": "https://files.pythonhosted.org/packages/c6/b9/cd8550d80b35e264eeb04ebc70d388c8310dd3083b3d429b8d40b7ee1217/apispec_webframeworks-0.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0a9af75ed10a8bf0cc704995e42b93e7", "sha256": "f32211535b6dff2978106ead70f084034a592e22db2318f36f51c999c10b2dc2" }, "downloads": -1, "filename": "apispec-webframeworks-0.0.2.tar.gz", "has_sig": false, "md5_digest": "0a9af75ed10a8bf0cc704995e42b93e7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6710, "upload_time": "2018-10-23T21:58:28", "url": "https://files.pythonhosted.org/packages/59/4b/6b5ff7eaa804b7ab2d16f4334b2bf6b8afefd85ea179043535a6f1cb480c/apispec-webframeworks-0.0.2.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "82c16c4636133e0e1d873a3c4c1fc020", "sha256": "b07689095ca846646a25b33aee6a104ef03256a3ea68ebc48af38ef1043f223f" }, "downloads": -1, "filename": "apispec_webframeworks-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "82c16c4636133e0e1d873a3c4c1fc020", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11759, "upload_time": "2018-10-28T18:53:09", "url": "https://files.pythonhosted.org/packages/22/10/e0c6d7e90bf3024c1df1e53ba1d467941263a442c2029bd17cd1144c74a8/apispec_webframeworks-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "47eff3c0c3f676ddf2d0fb93bf99be63", "sha256": "ffe3b0723644d88404a7c6c110970de0d69dd5ef7f03c53ff6f7b5e73722ad19" }, "downloads": -1, "filename": "apispec-webframeworks-0.1.0.tar.gz", "has_sig": false, "md5_digest": "47eff3c0c3f676ddf2d0fb93bf99be63", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7204, "upload_time": "2018-10-28T18:53:10", "url": "https://files.pythonhosted.org/packages/08/26/24b592b305f73112099e59978ce963a0f100206578fe8e43c309d8f08d6d/apispec-webframeworks-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "b4798f9eae7c645c3b31b266cabc6dbb", "sha256": "deb33d40023106ac087594da2e223c1affca920ea183cf885f99fa06bd18b9ea" }, "downloads": -1, "filename": "apispec_webframeworks-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b4798f9eae7c645c3b31b266cabc6dbb", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12186, "upload_time": "2018-11-07T00:44:44", "url": "https://files.pythonhosted.org/packages/3f/11/e41cd0928c1e1d1f49b855d949eace981f6c696978a6599e1328e0c69cf7/apispec_webframeworks-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "100d6239e577c2fb684189e43add11ec", "sha256": "cf1cdefb35b009787883aca725de90b76f07abd1142cdbea47215457df2706a2" }, "downloads": -1, "filename": "apispec-webframeworks-0.2.0.tar.gz", "has_sig": false, "md5_digest": "100d6239e577c2fb684189e43add11ec", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7348, "upload_time": "2018-11-07T00:44:46", "url": "https://files.pythonhosted.org/packages/3b/63/09bd15b94de5b5b9e8cc6471562942e4be341e4f16fb271b29683ed37c87/apispec-webframeworks-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "f96c66ce8d21fb1ed60790ae1ec7e999", "sha256": "2788277c39bb537a9e64561e768876bc27e4579b6e2c4acaf3c2442230ba229e" }, "downloads": -1, "filename": "apispec_webframeworks-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f96c66ce8d21fb1ed60790ae1ec7e999", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12525, "upload_time": "2019-01-31T13:44:34", "url": "https://files.pythonhosted.org/packages/66/67/9449e918d2b4a4a07d104f88783045a4dd63b21d3686f0b5e6d761012e5a/apispec_webframeworks-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f9cb7aff85c70510bf58027e9eb9fcb2", "sha256": "5957e05502a07a54750242f5252375ccdc1b32c5100713fcdeeb85757d6bf3ab" }, "downloads": -1, "filename": "apispec-webframeworks-0.3.0.tar.gz", "has_sig": false, "md5_digest": "f9cb7aff85c70510bf58027e9eb9fcb2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8103, "upload_time": "2019-01-31T13:44:35", "url": "https://files.pythonhosted.org/packages/c2/78/300fec9daa650c892a92d2b1d0ea791d112bb17c9c9e0e47248f5c37b1dd/apispec-webframeworks-0.3.0.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "8ccfd5fa66b66d28df6834828f4b78da", "sha256": "c138482361d6bde96c1f643136a44e8f1c958710bdd622328fd662e096be20e7" }, "downloads": -1, "filename": "apispec_webframeworks-0.4.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8ccfd5fa66b66d28df6834828f4b78da", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12646, "upload_time": "2019-03-22T02:30:58", "url": "https://files.pythonhosted.org/packages/42/4f/d9ffb3552c991284f461cf0f0c52c013c6b353ab8ae81d276c09773fa665/apispec_webframeworks-0.4.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "72cae5ca3ee9ca17a7ad78c2ba5d2dd7", "sha256": "6ef0179614ab92a0df0ab9f5f90692d11aec378d2d2e3af7c355cef6610463d7" }, "downloads": -1, "filename": "apispec-webframeworks-0.4.0.tar.gz", "has_sig": false, "md5_digest": "72cae5ca3ee9ca17a7ad78c2ba5d2dd7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8194, "upload_time": "2019-03-22T02:31:00", "url": "https://files.pythonhosted.org/packages/da/14/e57abcc87a2e276ceab1ef1ccd2c1810d6b79066df8371619ac713158148/apispec-webframeworks-0.4.0.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "5a86f6a8d07ffca29658038ccea0f2d3", "sha256": "02fb79a7e37bc4e71ad21f6a9ddfbfc8e919eede7ef685d35d2d8549c2d0282d" }, "downloads": -1, "filename": "apispec_webframeworks-0.5.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5a86f6a8d07ffca29658038ccea0f2d3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 12469, "upload_time": "2019-09-19T12:29:30", "url": "https://files.pythonhosted.org/packages/52/19/9e68b2b739763621ad011ef2120af61516fad5c1ea42e79fa699b34adfed/apispec_webframeworks-0.5.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ae6889d16a2db90071713786f8650e5d", "sha256": "89502de27f87e10766a62c9caf2ce4d33abce3acda91ae50abb3ef4937763b59" }, "downloads": -1, "filename": "apispec-webframeworks-0.5.0.tar.gz", "has_sig": false, "md5_digest": "ae6889d16a2db90071713786f8650e5d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 8817, "upload_time": "2019-09-19T12:29:32", "url": "https://files.pythonhosted.org/packages/6e/6e/b69ca3cdcabed4ea53c36f8a65e95d3cd00e86fd57fa8ce27de9fbe04290/apispec-webframeworks-0.5.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5a86f6a8d07ffca29658038ccea0f2d3", "sha256": "02fb79a7e37bc4e71ad21f6a9ddfbfc8e919eede7ef685d35d2d8549c2d0282d" }, "downloads": -1, "filename": "apispec_webframeworks-0.5.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5a86f6a8d07ffca29658038ccea0f2d3", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6", "size": 12469, "upload_time": "2019-09-19T12:29:30", "url": "https://files.pythonhosted.org/packages/52/19/9e68b2b739763621ad011ef2120af61516fad5c1ea42e79fa699b34adfed/apispec_webframeworks-0.5.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ae6889d16a2db90071713786f8650e5d", "sha256": "89502de27f87e10766a62c9caf2ce4d33abce3acda91ae50abb3ef4937763b59" }, "downloads": -1, "filename": "apispec-webframeworks-0.5.0.tar.gz", "has_sig": false, "md5_digest": "ae6889d16a2db90071713786f8650e5d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 8817, "upload_time": "2019-09-19T12:29:32", "url": "https://files.pythonhosted.org/packages/6e/6e/b69ca3cdcabed4ea53c36f8a65e95d3cd00e86fd57fa8ce27de9fbe04290/apispec-webframeworks-0.5.0.tar.gz" } ] }