Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
41 lines (30 sloc) 1.22 KB

Welcome to Qval's documentation!

Qval is a query parameters validation library. It is built using context managers and designed to work with Django Rest Framework, but also supports Django, Flask and Falcon.

Qval can validate incoming query parameters, convert them to python objects and automatically report errors to the client.

Get started

In order to use Qval in your project, install it with pip:

$ pip install qval

The usage is as simple as:

>>> from qval import validate
>>> with validate({"integer": "10"}, integer=int) as p:
...     print(type(p.integer) is int, p.integer)
True 10

For more verbose and clear examples refer to :ref:`basic_usage` and examples in the github repository.

.. toctree::
   :maxdepth: 2
   :caption: Contents

   basic_usage.rst
   frameworks.rst
   configuration.rst
   qval.rst
You can’t perform that action at this time.