mirror of
https://github.com/kennethreitz/pydantic.git
synced 2026-06-05 23:00:18 +00:00
Ondrej Kokes
ddc8e5a57b
* README change to make type annotations valid * example fixed to have valid type annotations * changes description * Update README.md explicit assignment for an optional field Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> * Update docs/examples/index_main.py explicit assignment for an optional field Co-Authored-By: Samuel Colvin <samcolvin@gmail.com> Co-authored-by: Samuel Colvin <samcolvin@gmail.com>
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# pydantic
|
|
|
|
[](https://travis-ci.org/samuelcolvin/pydantic)
|
|
[](https://codecov.io/gh/samuelcolvin/pydantic)
|
|
[](https://pypi.python.org/pypi/pydantic)
|
|
[](https://anaconda.org/conda-forge/pydantic)
|
|
[](https://pypistats.org/packages/pydantic)
|
|
[](https://github.com/samuelcolvin/pydantic)
|
|
[](https://github.com/samuelcolvin/pydantic/blob/master/LICENSE)
|
|
|
|
Data validation and settings management using Python type hinting.
|
|
|
|
Fast and extensible, *pydantic* plays nicely with your linters/IDE/brain.
|
|
Define how data should be in pure, canonical Python 3.6+; validate it with *pydantic*.
|
|
|
|
## Help
|
|
|
|
See [documentation](https://pydantic-docs.helpmanual.io/) for more details.
|
|
|
|
## Installation
|
|
|
|
Install using `pip install -U pydantic` or `conda install pydantic -c conda-forge`.
|
|
For more installation options to make *pydantic* even faster,
|
|
see the [Install](https://pydantic-docs.helpmanual.io/install/) section in the documentation.
|
|
|
|
## A Simple Example
|
|
|
|
```py
|
|
from datetime import datetime
|
|
from typing import List, Optional
|
|
from pydantic import BaseModel
|
|
|
|
class User(BaseModel):
|
|
id: int
|
|
name = 'John Doe'
|
|
signup_ts: Optional[datetime] = None
|
|
friends: List[int] = []
|
|
|
|
external_data = {'id': '123', 'signup_ts': '2017-06-01 12:22', 'friends': [1, '2', b'3']}
|
|
user = User(**external_data)
|
|
print(user)
|
|
#> User id=123 name='John Doe' signup_ts=datetime.datetime(2017, 6, 1, 12, 22) friends=[1, 2, 3]
|
|
print(user.id)
|
|
#> 123
|
|
```
|
|
|
|
## Contributing
|
|
|
|
For guidance on setting up a development environment and how to make a
|
|
contribution to *pydantic*, see
|
|
[Contributing to Pydantic](https://pydantic-docs.helpmanual.io/contributing/).
|
|
|
|
## Reporting a Security Vulnerability
|
|
|
|
See our [security policy](https://github.com/samuelcolvin/pydantic/security/policy).
|