=============
flask-smorest
=============
.. image:: https://img.shields.io/pypi/v/flask-smorest.svg
:target: https://pypi.org/project/flask-smorest/
:alt: Latest version
.. image:: https://img.shields.io/pypi/pyversions/flask-smorest.svg
:target: https://pypi.org/project/flask-smorest/
:alt: Python versions
.. image:: https://img.shields.io/badge/marshmallow-3-blue.svg
:target: https://marshmallow.readthedocs.io/en/latest/upgrading.html
:alt: marshmallow 3 only
.. image:: https://img.shields.io/badge/OAS-2%20|%203-green.svg
:target: https://github.com/OAI/OpenAPI-Specification
:alt: OpenAPI Specification 2/3 compatible
.. image:: https://img.shields.io/pypi/l/flask-smorest.svg
:target: https://flask-smorest.readthedocs.io/en/latest/license.html
:alt: License
.. image:: https://github.com/marshmallow-code/flask-smorest/actions/workflows/build-release.yml/badge.svg
:target: https://github.com/marshmallow-code/flask-smorest/actions?query=workflow%3Abuild
:alt: Build status
.. image:: https://codecov.io/gh/marshmallow-code/flask-smorest/branch/master/graph/badge.svg?token=F676tOSaLF
:target: https://codecov.io/gh/marshmallow-code/flask-smorest
:alt: Code coverage
.. image:: https://readthedocs.org/projects/flask-smorest/badge/
:target: http://flask-smorest.readthedocs.io/
:alt: Documentation
'cause everybody wants s'more
=============================
**flask-smorest** (formerly known as flask-rest-api) is a REST API framework
built upon `Flask <https://palletsprojects.com/p/flask/>`_ and
`marshmallow <https://github.com/marshmallow-code/marshmallow>`_.
- Serialization, deserialization and validation using marshmallow ``Schema``
- Explicit validation error messages returned in response
- Database-agnostic
- OpenAPI (Swagger) specification automatically generated and exposed with
`ReDoc <https://github.com/Rebilly/ReDoc>`_,
`Swagger UI <https://swagger.io/tools/swagger-ui/>`_ or
`RapiDoc <https://mrin9.github.io/RapiDoc/>`_
- Pagination
- ETag
Install
=======
::
pip install flask-smorest
Documentation
=============
Full documentation is available at http://flask-smorest.readthedocs.io/.
Support flask-smorest
======================
If you'd like to support the future of the project, please consider
contributing to marshmallow's Open Collective:
.. image:: https://opencollective.com/marshmallow/donate/button.png
:target: https://opencollective.com/marshmallow
:width: 200
:alt: Donate to our collective
License
=======
MIT licensed. See the `LICENSE <https://github.com/marshmallow-code/flask-smorest/blob/master/LICENSE>`_ file for more details.
Raw data
{
"_id": null,
"home_page": "https://github.com/marshmallow-code/flask-smorest",
"name": "flask-smorest",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "REST,openapi,swagger,flask,marshmallow,apispec,webargs",
"author": "J\u00e9r\u00f4me Lafr\u00e9choux",
"author_email": "jerome@jolimont.fr",
"download_url": "https://files.pythonhosted.org/packages/25/91/da55ec1288e821069ab61b6db4acfa171fa268c426523bb4f3a8a91210db/flask-smorest-0.42.3.tar.gz",
"platform": null,
"description": "=============\nflask-smorest \n=============\n\n.. image:: https://img.shields.io/pypi/v/flask-smorest.svg\n :target: https://pypi.org/project/flask-smorest/\n :alt: Latest version\n\n.. image:: https://img.shields.io/pypi/pyversions/flask-smorest.svg\n :target: https://pypi.org/project/flask-smorest/\n :alt: Python versions\n\n.. image:: https://img.shields.io/badge/marshmallow-3-blue.svg\n :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html\n :alt: marshmallow 3 only\n\n.. image:: https://img.shields.io/badge/OAS-2%20|%203-green.svg\n :target: https://github.com/OAI/OpenAPI-Specification\n :alt: OpenAPI Specification 2/3 compatible\n\n.. image:: https://img.shields.io/pypi/l/flask-smorest.svg\n :target: https://flask-smorest.readthedocs.io/en/latest/license.html\n :alt: License\n\n.. image:: https://github.com/marshmallow-code/flask-smorest/actions/workflows/build-release.yml/badge.svg\n :target: https://github.com/marshmallow-code/flask-smorest/actions?query=workflow%3Abuild\n :alt: Build status\n\n.. image:: https://codecov.io/gh/marshmallow-code/flask-smorest/branch/master/graph/badge.svg?token=F676tOSaLF\n :target: https://codecov.io/gh/marshmallow-code/flask-smorest\n :alt: Code coverage\n\n.. image:: https://readthedocs.org/projects/flask-smorest/badge/\n :target: http://flask-smorest.readthedocs.io/\n :alt: Documentation\n\n'cause everybody wants s'more\n=============================\n\n**flask-smorest** (formerly known as flask-rest-api) is a REST API framework\nbuilt upon `Flask <https://palletsprojects.com/p/flask/>`_ and\n`marshmallow <https://github.com/marshmallow-code/marshmallow>`_.\n\n- Serialization, deserialization and validation using marshmallow ``Schema``\n- Explicit validation error messages returned in response\n- Database-agnostic\n- OpenAPI (Swagger) specification automatically generated and exposed with\n `ReDoc <https://github.com/Rebilly/ReDoc>`_,\n `Swagger UI <https://swagger.io/tools/swagger-ui/>`_ or\n `RapiDoc <https://mrin9.github.io/RapiDoc/>`_\n- Pagination\n- ETag\n\nInstall\n=======\n\n::\n\n pip install flask-smorest\n\nDocumentation\n=============\n\nFull documentation is available at http://flask-smorest.readthedocs.io/.\n\nSupport flask-smorest\n======================\n\nIf you'd like to support the future of the project, please consider\ncontributing to marshmallow's Open Collective:\n\n.. image:: https://opencollective.com/marshmallow/donate/button.png\n :target: https://opencollective.com/marshmallow\n :width: 200\n :alt: Donate to our collective\n\nLicense\n=======\n\nMIT licensed. See the `LICENSE <https://github.com/marshmallow-code/flask-smorest/blob/master/LICENSE>`_ file for more details.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Flask/Marshmallow-based REST API framework",
"version": "0.42.3",
"project_urls": {
"Homepage": "https://github.com/marshmallow-code/flask-smorest"
},
"split_keywords": [
"rest",
"openapi",
"swagger",
"flask",
"marshmallow",
"apispec",
"webargs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "728bc37d6f38fe75461123f3d443bf431c37f5f8a21e2d8c4d4655f23a65a1b2",
"md5": "77996308f1bb00df6cd3bbd46f71674c",
"sha256": "992fadb76d944f25dbf0bfc96fa43666f455b106fa99e58a910e0ce7e98b0c51"
},
"downloads": -1,
"filename": "flask_smorest-0.42.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "77996308f1bb00df6cd3bbd46f71674c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 33117,
"upload_time": "2023-12-05T22:30:15",
"upload_time_iso_8601": "2023-12-05T22:30:15.916497Z",
"url": "https://files.pythonhosted.org/packages/72/8b/c37d6f38fe75461123f3d443bf431c37f5f8a21e2d8c4d4655f23a65a1b2/flask_smorest-0.42.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2591da55ec1288e821069ab61b6db4acfa171fa268c426523bb4f3a8a91210db",
"md5": "b10a7a0bdee4505dec3cc7652560bc9e",
"sha256": "736ef072bd5522de750a5a9d9f1bfb6d750d05c66e1b3702bc7a20e4277af9bf"
},
"downloads": -1,
"filename": "flask-smorest-0.42.3.tar.gz",
"has_sig": false,
"md5_digest": "b10a7a0bdee4505dec3cc7652560bc9e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 78102,
"upload_time": "2023-12-05T22:30:17",
"upload_time_iso_8601": "2023-12-05T22:30:17.619283Z",
"url": "https://files.pythonhosted.org/packages/25/91/da55ec1288e821069ab61b6db4acfa171fa268c426523bb4f3a8a91210db/flask-smorest-0.42.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-05 22:30:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "marshmallow-code",
"github_project": "flask-smorest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "flask-smorest"
}
JSON
