webargs

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.

``` {.sourceCode .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

Documentation

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

Support webargs

webargs is maintained by a group of volunteers. If you'd like to support the future of the project, please consider contributing to our Open Collective:

{width=”200px”}

Professional Support

Professionally-supported webargs is available through the Tidelift Subscription.

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]

Security Contact Information

To report a security vulnerability, please use the Tidelift security contact. 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 file for more details.

Contributing Guidelines

Security Contact Information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Questions, Feature Requests, Bug Reports, and Feedback…

…should all be reported on the GitHub Issue Tracker .

Contributing Code

Integration with a Another Web Framework…

…should be released as a separate package.

Pull requests adding support for another framework will not be accepted. In order to keep webargs small and easy to maintain, we are not currently adding support for more frameworks. Instead, release your framework integration as a separate package and add it to the Ecosystem page in the GitHub wiki .

Setting Up for Local Development

1. Fork webargs on GitHub.

$ git clone https://github.com/marshmallow-code/webargs.git
$ cd webargs

1. Install development requirements. It is highly recommended that you use a virtualenv. Use the following command to install an editable version of webargs along with its development requirements.

# After activating your virtualenv
$ pip install -e ".[dev]"

1. (Optional, but recommended) Install the pre-commit hooks, which will format and lint your git staged files.

# The pre-commit CLI was installed above
$ pre-commit install

Git Branch Structure

Webargs abides by the following branching model:

dev

Current development branch. New features should branch off here.

X.Y-line

Maintenance branch for release X.Y. Bug fixes should be sent to the most recent release branch.. The maintainer will forward-port the fix to dev. Note: exceptions may be made for bug fixes that introduce large code changes.

Always make a new branch for your work, no matter how small. Also, do not put unrelated changes in the same branch or pull request. This makes it more difficult to merge your changes.

Pull Requests

1. Create a new local branch.

# For a new feature
$ git checkout -b name-of-feature dev

# For a bugfix
$ git checkout -b fix-something 1.2-line

1. Commit your changes. Write good commit messages.

$ git commit -m "Detailed commit message"
$ git push origin name-of-feature

1. Before submitting a pull request, check the following:

• If the pull request adds functionality, it is tested and the docs are updated.
• You've added yourself to AUTHORS.rst.

4. Submit a pull request to marshmallow-code:dev or the appropriate maintenance branch. The CI build must be passing before your pull request is merged.

Running Tests

To run all tests: :

$ pytest

To run syntax checks: :

$ tox -e lint

(Optional) To run tests in all supported Python versions in their own virtual environments (must have each interpreter installed): :

$ tox

Documentation

Contributions to the documentation are welcome. Documentation is written in reStructuredText (rST). A quick rST reference can be found here. Builds are powered by Sphinx.

To build the docs in "watch" mode: :

$ tox -e watch-docs

Changes in the [docs/]{.title-ref} directory will automatically trigger a rebuild.

Contributing Examples

Have a usage example you'd like to share? Feel free to add it to the examples directory and send a pull request.