.. voluptuous documentation master file, created by
   sphinx-quickstart on Tue Jun 13 21:29:23 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to voluptuous's documentation!
======================================

.. image:: https://img.shields.io/pypi/v/voluptuous.svg
   :target: https://python.org/pypi/voluptuous
   :alt: Package on PyPI

.. image:: https://img.shields.io/pypi/l/voluptuous.svg
   :target: https://python.org/pypi/voluptuous
   :alt: BSD

.. image:: https://img.shields.io/pypi/pyversions/voluptuous.svg
   :target: https://python.org/pypi/voluptuous
   :alt: Python Versions

.. image:: https://github.com/alecthomas/voluptuous/actions/workflows/tests.yml/badge.svg
    :target: https://github.com/alecthomas/voluptuous/actions/workflows/tests.yml
    :alt: Test Status


Voluptuous, despite the name, is a Python data validation library. It is primarily intended for validating data coming into Python as JSON, YAML, etc.

It has three goals:

#. Simplicity.
#. Support for complex data structures.
#. Provide useful error messages.

Content
==================

.. toctree::
   :maxdepth: 2

   modules

Document version:
|version|
|release|

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`