/BRdocs-validation

Validate brazilian documents using Type Hints in classes inheriting Pydantic's (V2) BaseModel

Primary LanguagePythonMIT LicenseMIT

Test codecov PyPI version PyPI - Python Version Pydantic V2

Install

pip install brdocs-validation

Supported docs and its formats

Supports Description Format Format's support
CNPJ 12.345.678/9012-34 OR Without special chars
CPF 123.456.789-01 OR Without special chars
CNH Only numbers Length: 11
NIS/PIS/PASEP/NIT Use NIS type for PIS, PASEP, NIT 123.45678.90-1 OR Only numbers
CNS Cartão Nacional de Saúde Only numbers
RENAVAM Only numbers Length: 9, 10 & 11

Usage

from br_docs import CNPJ, CPF, CNH, NIS, CNS, RENAVAM
from pydantic import BaseModel


class User(BaseModel):
    cpf: CPF
    cnpj: CNPJ
    cnh: CNH
    nis: NIS
    cns: CNS
    renavam: RENAVAM