webargs


Namewebargs JSON
Version 8.6.0 PyPI version JSON
download
home_pageNone
SummaryDeclarative parsing and validation of HTTP request objects, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, Falcon, and aiohttp.
upload_time2024-09-11 07:55:06
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords webargs http flask django bottle tornado aiohttp request arguments validation parameters rest api marshmallow
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            *******
webargs
*******

|pypi| |build-status| |docs| |marshmallow3|

.. |pypi| image:: https://badgen.net/pypi/v/webargs
    :target: https://pypi.org/project/webargs/
    :alt: PyPI package

.. |build-status| image:: https://github.com/marshmallow-code/webargs/actions/workflows/build-release.yml/badge.svg
    :target: https://github.com/marshmallow-code/webargs/actions/workflows/build-release.yml
    :alt: Build status

.. |docs| image:: https://readthedocs.org/projects/webargs/badge/
   :target: https://webargs.readthedocs.io/
   :alt: Documentation

.. |marshmallow3| image:: https://badgen.net/badge/marshmallow/3
    :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html
    :alt: marshmallow 3 compatible

Homepage: https://webargs.readthedocs.io/

webargs is a Python library for parsing and validating HTTP request objects, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, Falcon, and aiohttp.

.. code-block:: python

    from flask import Flask
    from webargs import fields
    from webargs.flaskparser import use_args

    app = Flask(__name__)


    @app.route("/")
    @use_args({"name": fields.Str(required=True)}, location="query")
    def index(args):
        return "Hello " + args["name"]


    if __name__ == "__main__":
        app.run()

    # curl http://localhost:5000/\?name\='World'
    # Hello World

Install
=======

::

    pip install -U webargs

webargs supports Python >= 3.8.


Documentation
=============

Full documentation is available at https://webargs.readthedocs.io/.

Support webargs
===============

webargs is maintained by a group of 
`volunteers <https://webargs.readthedocs.io/en/latest/authors.html>`_.
If you'd like to support the future of the project, please consider
contributing to our Open Collective:

.. image:: https://opencollective.com/marshmallow/donate/button.png
    :target: https://opencollective.com/marshmallow
    :width: 200
    :alt: Donate to our collective

Professional Support
====================

Professionally-supported webargs is available through the
`Tidelift Subscription <https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-webargs&utm_medium=referral&utm_campaign=readme>`_.

Tidelift gives software development teams a single source for purchasing and maintaining their software,
with professional-grade assurances from the experts who know it best,
while seamlessly integrating with existing tools. [`Get professional support`_]

.. _`Get professional support`: https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-webargs&utm_medium=referral&utm_campaign=readme

.. image:: https://user-images.githubusercontent.com/2379650/45126032-50b69880-b13f-11e8-9c2c-abd16c433495.png
    :target: https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-webargs&utm_medium=referral&utm_campaign=readme
    :alt: Get supported marshmallow with Tidelift

Security Contact Information
============================

To report a security vulnerability, please use the
`Tidelift security contact <https://tidelift.com/security>`_.
Tidelift will coordinate the fix and disclosure.

Project Links
=============

- Docs: https://webargs.readthedocs.io/
- Changelog: https://webargs.readthedocs.io/en/latest/changelog.html
- Contributing Guidelines: https://webargs.readthedocs.io/en/latest/contributing.html
- PyPI: https://pypi.python.org/pypi/webargs
- Issues: https://github.com/marshmallow-code/webargs/issues
- Ecosystem / related packages: https://github.com/marshmallow-code/webargs/wiki/Ecosystem


License
=======

MIT licensed. See the `LICENSE <https://github.com/marshmallow-code/webargs/blob/dev/LICENSE>`_ file for more details.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "webargs",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Steven Loria <sloria1@gmail.com>, J\u00e9r\u00f4me Lafr\u00e9choux <jerome@jolimont.fr>, Stephen Rosen <sirosen0@gmail.com>",
    "keywords": "webargs, http, flask, django, bottle, tornado, aiohttp, request, arguments, validation, parameters, rest, api, marshmallow",
    "author": null,
    "author_email": "Steven Loria <sloria1@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/8c/51/e9ee5d8315864adf65e92f858f826514538e30db542d4782dd94c2418464/webargs-8.6.0.tar.gz",
    "platform": null,
    "description": "*******\nwebargs\n*******\n\n|pypi| |build-status| |docs| |marshmallow3|\n\n.. |pypi| image:: https://badgen.net/pypi/v/webargs\n    :target: https://pypi.org/project/webargs/\n    :alt: PyPI package\n\n.. |build-status| image:: https://github.com/marshmallow-code/webargs/actions/workflows/build-release.yml/badge.svg\n    :target: https://github.com/marshmallow-code/webargs/actions/workflows/build-release.yml\n    :alt: Build status\n\n.. |docs| image:: https://readthedocs.org/projects/webargs/badge/\n   :target: https://webargs.readthedocs.io/\n   :alt: Documentation\n\n.. |marshmallow3| image:: https://badgen.net/badge/marshmallow/3\n    :target: https://marshmallow.readthedocs.io/en/latest/upgrading.html\n    :alt: marshmallow 3 compatible\n\nHomepage: https://webargs.readthedocs.io/\n\nwebargs is a Python library for parsing and validating HTTP request objects, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, Falcon, and aiohttp.\n\n.. code-block:: python\n\n    from flask import Flask\n    from webargs import fields\n    from webargs.flaskparser import use_args\n\n    app = Flask(__name__)\n\n\n    @app.route(\"/\")\n    @use_args({\"name\": fields.Str(required=True)}, location=\"query\")\n    def index(args):\n        return \"Hello \" + args[\"name\"]\n\n\n    if __name__ == \"__main__\":\n        app.run()\n\n    # curl http://localhost:5000/\\?name\\='World'\n    # Hello World\n\nInstall\n=======\n\n::\n\n    pip install -U webargs\n\nwebargs supports Python >= 3.8.\n\n\nDocumentation\n=============\n\nFull documentation is available at https://webargs.readthedocs.io/.\n\nSupport webargs\n===============\n\nwebargs is maintained by a group of \n`volunteers <https://webargs.readthedocs.io/en/latest/authors.html>`_.\nIf you'd like to support the future of the project, please consider\ncontributing to our 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\nProfessional Support\n====================\n\nProfessionally-supported webargs is available through the\n`Tidelift Subscription <https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-webargs&utm_medium=referral&utm_campaign=readme>`_.\n\nTidelift gives software development teams a single source for purchasing and maintaining their software,\nwith professional-grade assurances from the experts who know it best,\nwhile seamlessly integrating with existing tools. [`Get professional support`_]\n\n.. _`Get professional support`: https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-webargs&utm_medium=referral&utm_campaign=readme\n\n.. image:: https://user-images.githubusercontent.com/2379650/45126032-50b69880-b13f-11e8-9c2c-abd16c433495.png\n    :target: https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-webargs&utm_medium=referral&utm_campaign=readme\n    :alt: Get supported marshmallow with Tidelift\n\nSecurity Contact Information\n============================\n\nTo report a security vulnerability, please use the\n`Tidelift security contact <https://tidelift.com/security>`_.\nTidelift will coordinate the fix and disclosure.\n\nProject Links\n=============\n\n- Docs: https://webargs.readthedocs.io/\n- Changelog: https://webargs.readthedocs.io/en/latest/changelog.html\n- Contributing Guidelines: https://webargs.readthedocs.io/en/latest/contributing.html\n- PyPI: https://pypi.python.org/pypi/webargs\n- Issues: https://github.com/marshmallow-code/webargs/issues\n- Ecosystem / related packages: https://github.com/marshmallow-code/webargs/wiki/Ecosystem\n\n\nLicense\n=======\n\nMIT licensed. See the `LICENSE <https://github.com/marshmallow-code/webargs/blob/dev/LICENSE>`_ file for more details.\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Declarative parsing and validation of HTTP request objects, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, Falcon, and aiohttp.",
    "version": "8.6.0",
    "project_urls": {
        "Changelog": "https://webargs.readthedocs.io/en/latest/changelog.html",
        "Funding": "https://opencollective.com/marshmallow",
        "Issues": "https://github.com/marshmallow-code/webargs/issues",
        "Source": "https://github.com/marshmallow-code/webargs",
        "Tidelift": "https://tidelift.com/subscription/pkg/pypi-webargs?utm_source=pypi-webargs&utm_medium=pypi"
    },
    "split_keywords": [
        "webargs",
        " http",
        " flask",
        " django",
        " bottle",
        " tornado",
        " aiohttp",
        " request",
        " arguments",
        " validation",
        " parameters",
        " rest",
        " api",
        " marshmallow"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "79bbb9b77adeecffd7b41615a7ebd607ac28bd9e09f357d31ce68073b77f0f30",
                "md5": "6a65b1dbff4e6b841300c5dd4d25c618",
                "sha256": "83da4d7105643d0a50499b06d98a6ade1a330ce66d039eaa51f715172c704aba"
            },
            "downloads": -1,
            "filename": "webargs-8.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6a65b1dbff4e6b841300c5dd4d25c618",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 31831,
            "upload_time": "2024-09-11T07:55:05",
            "upload_time_iso_8601": "2024-09-11T07:55:05.909530Z",
            "url": "https://files.pythonhosted.org/packages/79/bb/b9b77adeecffd7b41615a7ebd607ac28bd9e09f357d31ce68073b77f0f30/webargs-8.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8c51e9ee5d8315864adf65e92f858f826514538e30db542d4782dd94c2418464",
                "md5": "bb65a1f2964f24f77650b8a14ddfbdb1",
                "sha256": "b8d098ab92bd74c659eca705afa31d681475f218cb15c1e57271fa2103c0547a"
            },
            "downloads": -1,
            "filename": "webargs-8.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bb65a1f2964f24f77650b8a14ddfbdb1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 96610,
            "upload_time": "2024-09-11T07:55:06",
            "upload_time_iso_8601": "2024-09-11T07:55:06.971922Z",
            "url": "https://files.pythonhosted.org/packages/8c/51/e9ee5d8315864adf65e92f858f826514538e30db542d4782dd94c2418464/webargs-8.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-11 07:55:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "marshmallow-code",
    "github_project": "webargs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "webargs"
}
        
Elapsed time: 0.47336s