brdocs-validation


Namebrdocs-validation JSON
Version 0.4.0 PyPI version JSON
download
home_pageNone
SummaryValidate brazilian documents using Type Hints in classes inheriting Pydantic's (V2) BaseModel
upload_time2024-05-13 23:22:47
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords pydantic-v2 cpf-validador cnpj-validador validador-pispasep validador-titulo-eleitor
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![Test](https://github.com/vinicius-oa/BRdocs-validation/actions/workflows/test.yml/badge.svg)
![codecov](https://codecov.io/gh/vinicius-oa/BRdocs-validation/graph/badge.svg?token=Z211YIKO8L)
![PyPI - Version](https://img.shields.io/pypi/v/brdocs-validation?label=pypi%20package&color=2334D058)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/brdocs-validation?color=2334D058)
![Pydantic V2](https://img.shields.io/badge/Pydantic_V2->=2.0-2334D058.svg)

## 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_ | 
|        TE         |             Título de eleitor             |                  Only numbers                   |                      |
|       CERT        | Certidão de casamento, nascimento e óbito |                  Only numbers                   |                      | 
|        SEI        |         Número do Processo SEI            | 12345-67890123/4567-89 OR without special chars |                      |

## Usage 

```python
from br_docs import CNPJ, CPF, CNH, NIS, CNS, RENAVAM, TE, CERT, SEI
from pydantic import BaseModel


class User(BaseModel):
    cpf: CPF
    cnpj: CNPJ
    cnh: CNH
    nis: NIS
    cns: CNS
    renavam: RENAVAM
    te: TE
    cert: CERT
    sei: SEI
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "brdocs-validation",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "Vin\u00edcius Aguiar <vaguiararqdevsoftware@proton.me>",
    "keywords": "pydantic-v2, cpf-validador, cnpj-validador, validador-pispasep, validador-titulo-eleitor",
    "author": null,
    "author_email": "Vin\u00edcius Aguiar <vaguiararqdevsoftware@proton.me>",
    "download_url": "https://files.pythonhosted.org/packages/c5/ff/da7d280b588939591d0f48d052c5efb57c2016b75b6cae0a1db0a9b6408f/brdocs_validation-0.4.0.tar.gz",
    "platform": null,
    "description": "![Test](https://github.com/vinicius-oa/BRdocs-validation/actions/workflows/test.yml/badge.svg)\n![codecov](https://codecov.io/gh/vinicius-oa/BRdocs-validation/graph/badge.svg?token=Z211YIKO8L)\n![PyPI - Version](https://img.shields.io/pypi/v/brdocs-validation?label=pypi%20package&color=2334D058)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/brdocs-validation?color=2334D058)\n![Pydantic V2](https://img.shields.io/badge/Pydantic_V2->=2.0-2334D058.svg)\n\n## Install\n```\npip install brdocs-validation\n```\n\n\n## Supported docs and its formats\n\n|     Supports      |                Description                |                     Format                      |   Format's support   | \n|:-----------------:|:-----------------------------------------:|:-----------------------------------------------:|:--------------------:|\n|       CNPJ        |                                           | *12.345.678/9012-34* OR _Without special chars_ |                      |\n|        CPF        |                                           |   *123.456.789-01* OR _Without special chars_   |                      |\n|        CNH        |                                           |                  Only numbers                   |     Length: _11_     |\n| NIS/PIS/PASEP/NIT | Use _**NIS**_ type for _PIS, PASEP, NIT_  |       *123.45678.90-1* OR _Only numbers_        |                      |\n|        CNS        |         Cart\u00e3o Nacional de Sa\u00fade          |                  Only numbers                   |                      |\n|      RENAVAM      |                                           |                  Only numbers                   | Length: _9, 10 & 11_ | \n|        TE         |             T\u00edtulo de eleitor             |                  Only numbers                   |                      |\n|       CERT        | Certid\u00e3o de casamento, nascimento e \u00f3bito |                  Only numbers                   |                      | \n|        SEI        |         N\u00famero do Processo SEI            | 12345-67890123/4567-89 OR without special chars |                      |\n\n## Usage \n\n```python\nfrom br_docs import CNPJ, CPF, CNH, NIS, CNS, RENAVAM, TE, CERT, SEI\nfrom pydantic import BaseModel\n\n\nclass User(BaseModel):\n    cpf: CPF\n    cnpj: CNPJ\n    cnh: CNH\n    nis: NIS\n    cns: CNS\n    renavam: RENAVAM\n    te: TE\n    cert: CERT\n    sei: SEI\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Validate brazilian documents using Type Hints in classes inheriting Pydantic's (V2) BaseModel",
    "version": "0.4.0",
    "project_urls": {
        "Repository": "https://github.com/vinicius-oa/BRdocs-validation"
    },
    "split_keywords": [
        "pydantic-v2",
        " cpf-validador",
        " cnpj-validador",
        " validador-pispasep",
        " validador-titulo-eleitor"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cd9114334305b6866d94e13cadcca3021ac5c7941497a60ec4964d8952129fbe",
                "md5": "403f978dd4e01ac7d30f6ee26a9e8a8c",
                "sha256": "436b2c142c045b902813c7aa326704d2e357e5c90968365ef285f3b078ba57d5"
            },
            "downloads": -1,
            "filename": "brdocs_validation-0.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "403f978dd4e01ac7d30f6ee26a9e8a8c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 10126,
            "upload_time": "2024-05-13T23:22:45",
            "upload_time_iso_8601": "2024-05-13T23:22:45.791724Z",
            "url": "https://files.pythonhosted.org/packages/cd/91/14334305b6866d94e13cadcca3021ac5c7941497a60ec4964d8952129fbe/brdocs_validation-0.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c5ffda7d280b588939591d0f48d052c5efb57c2016b75b6cae0a1db0a9b6408f",
                "md5": "dc86fc1b488a83750946fc235bc8366a",
                "sha256": "e37d630e96d163a13399cc9fd66a5d258aea406364613462478224a18fdc1dcd"
            },
            "downloads": -1,
            "filename": "brdocs_validation-0.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "dc86fc1b488a83750946fc235bc8366a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 8463,
            "upload_time": "2024-05-13T23:22:47",
            "upload_time_iso_8601": "2024-05-13T23:22:47.419560Z",
            "url": "https://files.pythonhosted.org/packages/c5/ff/da7d280b588939591d0f48d052c5efb57c2016b75b6cae0a1db0a9b6408f/brdocs_validation-0.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-13 23:22:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "vinicius-oa",
    "github_project": "BRdocs-validation",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "brdocs-validation"
}
        
Elapsed time: 0.48591s