aboutsummaryrefslogtreecommitdiff
path: root/docs/integrations/index.rst
blob: 9267d077301b96b76fdfa94fb8240cce39fe7ec6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
Integrations
============

Edify ships lightweight integration modules that let you drop a compiled
:class:`edify.Pattern` into the field-validation layers of the frameworks
most Python teams actually use. Each integration is an opt-in extra —
``pip install edify`` never pulls the framework in, and importing an
integration module never imports the framework at module load time. The
first helper call resolves the framework lazily; when the extra is
missing you get a clean :class:`edify.errors.integration.MissingIntegrationDependencyError`
with the exact install line to run.

Install any one, or all three:

.. code-block:: shell

    pip install 'edify[pydantic]'
    pip install 'edify[fastapi]'
    pip install 'edify[django]'
    pip install 'edify[all]'


Pydantic
--------

.. automodule:: edify.integrations.pydantic
    :members:


FastAPI
-------

.. automodule:: edify.integrations.fastapi
    :members:


Django
------

.. automodule:: edify.integrations.django
    :members: