mirror of
https://github.com/kennethreitz/pydantic.git
synced 2026-06-05 23:00:18 +00:00
Samuel Colvin
33b7d52d31
* moving docs to mkdocs * transfering readme to md and more * fixing build * splitting usage.md * improving schema.md and index.md * fix make_history.rst * models intro * working on data conversation and required fields * more fixes to models.md * list all standard types supported * list of pydantic types * tweaks * update links in code * Apply suggestions from code review incorporate @dmontagu's suggestions. Co-Authored-By: dmontagu <35119617+dmontagu@users.noreply.github.com> * Apply suggestions from code review more missed suggestions. Co-Authored-By: dmontagu <35119617+dmontagu@users.noreply.github.com> * Apply suggestions from code review more corrects. * cleanup * Field order warning * fix and regenerate benchmarks * format examples better, cleanup * improve schema mapping table * correct highlighting file types in schema.md * add redirects in javascript * add logo
44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
|
|
Just:
|
|
|
|
```py
|
|
pip install pydantic
|
|
```
|
|
|
|
*pydantic* has no required dependencies except python 3.6 or 3.7 (and the dataclasses package in python 3.6).
|
|
If you've got python 3.6 and `pip` installed - you're good to go.
|
|
|
|
Pydantic is also available on [conda](https://www.anaconda.com) under the [conda-forge](https://conda-forge.org)
|
|
channel:
|
|
|
|
```bash
|
|
conda install pydantic -c conda-forge
|
|
```
|
|
|
|
*pydantic* can optionally be compiled with [cython](https://cython.org/) which should give a 30-50% performance
|
|
improvement. `manylinux` binaries exist for python 3.6 and 3.7, so if you're installing from PyPI on linux, you
|
|
should get *pydantic* compiled with no extra work. If you're installing manually, install `cython` before installing
|
|
*pydantic* and you should get *pydandic* compiled. Compilation with cython
|
|
[is not](https://github.com/samuelcolvin/pydantic/issues/555) tested on windows or mac.
|
|
|
|
To test if *pydantic* is compiled run:
|
|
|
|
```py
|
|
import pydantic
|
|
print('compiled:', pydantic.compiled)
|
|
```
|
|
|
|
If you require email validation you can add [email-validator](https://github.com/JoshData/python-email-validator)
|
|
as an optional dependency. Similarly, use of `Literal` relies on
|
|
[typing-extensions](https://pypi.org/project/typing-extensions/):
|
|
|
|
```bash
|
|
pip install pydantic[email]
|
|
# or
|
|
pip install pydantic[typing_extensions]
|
|
# or just
|
|
pip install pydantic[email,typing_extensions]
|
|
```
|
|
|
|
Of course you can also install these requirements manually with `pip install ...`.
|