{
    "info": {
        "author": "\u00c1lvaro Ferreira Pires de Paiva",
        "author_email": "alvarofepipa@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "# validate-docbr\n<a href=\"https://pypi.org/project/validate-docbr/\">\n  <img src=\"https://img.shields.io/pypi/v/validate-docbr.svg\" alt=\"latest release\" />\n</a>\n\nPacote Python para valida\u00e7\u00e3o de documentos brasileiros.\n\nPara instalar o pacote:\n```bash\npip install validate-docbr\n```\n\nA documenta\u00e7\u00e3o pode ser acessada [clicando aqui](https://alvarofpp.github.io/validate-docbr).\n\n## Documentos\nDocumentos que est\u00e3o no pacote:\n\n- [CPF](validate_docbr/CPF.py): Cadastro de Pessoas F\u00edsicas;\n- [CNH](validate_docbr/CNH.py): Carteira Nacional de Habilita\u00e7\u00e3o;\n- [CNPJ](validate_docbr/CNPJ.py): Cadastro Nacional da Pessoa Jur\u00eddica;\n- [CNS](validate_docbr/CNS.py): Cart\u00e3o Nacional de Sa\u00fade;\n- [PIS](validate_docbr/PIS.py): PIS/NIS/PASEP/NIT;\n- [T\u00edtulo eleitoral](validate_docbr/TituloEleitoral.py): Cadastro que permite cidad\u00e3os brasileiros votar;\n- [RENAVAM](validate_docbr/RENAVAM.py): Registro Nacional de Ve\u00edculos Automotores.\n\nPara entender melhor os documentos e suas respectivas classes, basta acessar a [Wiki do projeto](https://github.com/alvarofpp/validate-docbr/wiki).\n\n## M\u00e9todos\nTodos os documentos possuem os mesmos m\u00e9todos e funcionam da mesma forma.\n\n### validate\nValida o documento passado como argumento. Retorna um `bool`, `True` caso seja v\u00e1lido, `False` caso contr\u00e1rio . Recebe os par\u00e2metros:\n\n| Par\u00e2metro | Tipo | Valor padr\u00e3o | Obrigat\u00f3rio | Descri\u00e7\u00e3o |\n| --------- | ---- | ----------- | ------------ | --------- |\n| `doc` | `str`| `''` | X | O documento que se quer validar. |\n\n```python\nfrom validate_docbr import CPF\n\ncpf = CPF()\n\n# Validar CPF\ncpf.validate(\"012.345.678-90\")  # True\ncpf.validate(\"012.345.678-91\")  # False\n```\n\n[Caso especial de CPF](https://alvarofpp.github.io/validate-docbr/guia-de-uso/#caso-especial-de-cpf).\n\n### validate_list\n\nValida uma lista de documentos passado como argumento. Retorna uma lista de `bool`, `True` caso seja v\u00e1lido, `False` caso contr\u00e1rio. Recebe os par\u00e2metros:\n\n| Par\u00e2metro | Tipo | Valor padr\u00e3o | Obrigat\u00f3rio | Descri\u00e7\u00e3o |\n| --------- | ---- | ----------- | ------------ | --------- |\n| `docs` | `List[str]`| `[]` | X | A lista de documentos para validar. |\n\n```python\nfrom validate_docbr import CPF\n\ncpf = CPF()\n\n# Validar CPFs\ncpf.validate_list([\"012.345.678-90\", \"012.345.678-91\"])  # [True, False]\n```\n\n### validate_docs\n**Observa\u00e7\u00e3o**: diferente dos outros m\u00e9todos, esse m\u00e9todo \u00e9 do escopo global do pacote, n\u00e3o precisa-se instanciar uma classe para uso.\n\nValida v\u00e1rios documentos difererentes. Retorna uma lista com valores `bool` para cada tupla da lista (na mesma ordem), `True` caso seja v\u00e1lido, `False` caso contr\u00e1rio . Recebe os par\u00e2metros:\n\n| Par\u00e2metro | Tipo | Valor padr\u00e3o | Obrigat\u00f3rio | Descri\u00e7\u00e3o |\n| --------- | ---- | ----------- | ------------ | --------- |\n| `documents` | `List[Tuple[BaseDoc, str]]`| `[]` | X | Lista de tuplas, cada tupla possui como primeiro elemento o tipo de documento e o segundo elemento o valor que se deseja validar. |\n\n```python\nimport validate_docbr as docbr\n\n\n# Validar diferentes documentos\ndocs = [(docbr.CPF, '90396100457'), (docbr.CNPJ, '49910753848365')]\ndocbr.validate_docs(docs)  # [True, False]\n```\n\n### generate\nGera um novo documento, retorna em formato de `str`. Recebe os par\u00e2metros:\n\n| Par\u00e2metro | Tipo | Valor padr\u00e3o | Obrigat\u00f3rio | Descri\u00e7\u00e3o |\n| --------- | ---- | ----------- | ------------ | --------- |\n| `mask` | `bool` | `False` | - | Quando possui o valor `True`, o documento retornado estar\u00e1 formatado. |\n\n```python\nfrom validate_docbr import CPF\n\ncpf = CPF()\n\n# Gerar novo CPF\nnew_cpf_one = cpf.generate()  # \"01234567890\"\nnew_cpf_two = cpf.generate(True)  # \"012.345.678-90\"\n```\n\n### generate_list\nGera uma lista de documentos, retorna em formato de `list` com elementos do tipo `str`. Recebe os par\u00e2metros:\n\n| Par\u00e2metro | Tipo | Valor padr\u00e3o | Obrigat\u00f3rio | Descri\u00e7\u00e3o |\n| --------- | ---- | ----------- | ------------ | --------- |\n| `n` | `int` | `1` | X | A quantidade desejada de documentos que ser\u00e3o gerados. |\n| `mask` | `bool` | `False` | - | Se os documentos gerados dever\u00e3o ter ou n\u00e3o m\u00e1scara. |\n| `repeat` | `bool` | `False` | - | Se aceita ou n\u00e3o documentos repetidos. |\n    \n```python\nfrom validate_docbr import CPF\n\ncpf = CPF()\n\n# Gerar lista de CPFs\ncpfs_one = cpf.generate_list(2)  # [ \"85215667438\", \"28293145811\" ]\ncpfs_two = cpf.generate_list(2, True)  # [ \"852.156.674-38\", \"282.931.458-11\" ]\n```\n\n### mask\nMascara o documento passado como argumento. Retorna um `str` que \u00e9 o documento mascarado . Recebe os par\u00e2metros:\n\n| Par\u00e2metro | Tipo | Valor padr\u00e3o | Obrigat\u00f3rio | Descri\u00e7\u00e3o |\n| --------- | ---- | ----------- | ------------ | --------- |\n| `doc` | `str`| `''` | X | O documento que se quer mascarar. |\n\n```python\nfrom validate_docbr import CPF\n\ncpf = CPF()\n\ncpf_me = \"01234567890\"\n\n# Mascara o CPF\ncpf.mask(cpf_me)  # \"012.345.678-90\"\n```\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/alvarofpp/validate-docbr",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "validate-docbr",
        "package_url": "https://pypi.org/project/validate-docbr/",
        "platform": "",
        "project_url": "https://pypi.org/project/validate-docbr/",
        "project_urls": {
            "Homepage": "https://github.com/alvarofpp/validate-docbr"
        },
        "release_url": "https://pypi.org/project/validate-docbr/1.10.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Validate brazilian documents.",
        "version": "1.10.0",
        "yanked": false,
        "yanked_reason": null
    },
    "last_serial": 11839008,
    "releases": {
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3553fb04b8e2c676331430666e1c908e",
                    "sha256": "f71a45836bfbe8da06f47f5cc66c5ac96454016be20ff60177c68b598273267c"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3553fb04b8e2c676331430666e1c908e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6752,
                "upload_time": "2019-03-21T18:53:29",
                "upload_time_iso_8601": "2019-03-21T18:53:29.900998Z",
                "url": "https://files.pythonhosted.org/packages/11/a7/bdbe55f1920806f08cd9fbaf99c7147323fe98ab9c572ea4c6440871b49e/validate_docbr-1.1.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.10.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "90d2f8bd1376a7c0472e5c4c0fefe571",
                    "sha256": "ff016f180b0c5ecff06abce1d83385924438c4d4c7f5c050e90fb724f1d968bb"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.10.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "90d2f8bd1376a7c0472e5c4c0fefe571",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 18814,
                "upload_time": "2021-10-26T19:35:20",
                "upload_time_iso_8601": "2021-10-26T19:35:20.444908Z",
                "url": "https://files.pythonhosted.org/packages/8b/0d/799d5c729efb85a8bd7786c7cb55780bb66f9c386ec805198e05d3fa0c80/validate_docbr-1.10.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "83295e6c89e993bb52c99b67a05906ee",
                    "sha256": "e14a0bc2268e4ba5aa583a43e252601dc50bd3993b37860b8a825e89151d39bd"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "83295e6c89e993bb52c99b67a05906ee",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 7410,
                "upload_time": "2019-03-27T18:38:08",
                "upload_time_iso_8601": "2019-03-27T18:38:08.984137Z",
                "url": "https://files.pythonhosted.org/packages/41/9d/db1ba47a0f482c5ccad43774af9449d48e6163f8ab1d253f7e4993e488d9/validate_docbr-1.2.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4cb05b59cc165315da36297c04039e4f",
                    "sha256": "88c475cc857d431efc9811e1078ff7ccbd101eb4ab02553321966bf59ce13991"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.2.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4cb05b59cc165315da36297c04039e4f",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6428,
                "upload_time": "2019-08-20T14:25:28",
                "upload_time_iso_8601": "2019-08-20T14:25:28.203561Z",
                "url": "https://files.pythonhosted.org/packages/7d/04/d39d797f7c47c123c72edd451919f7d3e63a5cb34eef447a6979e68d2211/validate_docbr-1.2.1-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "18fb81e004c33e6b1247936f5392e2e3",
                    "sha256": "c2213a7b057c963f6990e7c11d057cff154f5def3d5654801720d65c04efacda"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.3.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "18fb81e004c33e6b1247936f5392e2e3",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 8568,
                "upload_time": "2019-09-08T18:19:42",
                "upload_time_iso_8601": "2019-09-08T18:19:42.229282Z",
                "url": "https://files.pythonhosted.org/packages/b9/2f/e872e94e6b73caaf5ca9003dcc2c56b1f5dbbeabc8285801c08f0efc5e8b/validate_docbr-1.3.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8bd7d10b54c0feba3048549f115bbaa7",
                    "sha256": "69c9a9b990e94bd9807385ee70c6a8a54715aa8d7363e859695cb0571a80896d"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.4.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8bd7d10b54c0feba3048549f115bbaa7",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9644,
                "upload_time": "2019-10-02T20:52:54",
                "upload_time_iso_8601": "2019-10-02T20:52:54.865578Z",
                "url": "https://files.pythonhosted.org/packages/e7/56/8292f86407b49730458e981ba047a0abbb65ea416010e366f6aa957f7245/validate_docbr-1.4.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.5.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a87be5fb0b5c5a979d31b3199afe21ef",
                    "sha256": "26fc1518188ac1c1e3f33e18d8232399b0be6a885120263f2e015828ff57cf08"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.5.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a87be5fb0b5c5a979d31b3199afe21ef",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 11659,
                "upload_time": "2019-10-22T20:10:50",
                "upload_time_iso_8601": "2019-10-22T20:10:50.813622Z",
                "url": "https://files.pythonhosted.org/packages/a3/1f/92f349aba0210bddb9f961a98623385562833d252e927e17ff5a5f982bdd/validate_docbr-1.5.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.6.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8694118e67f4593dc3cdfde0a2bfbb10",
                    "sha256": "d6a39526d4abc3bb2a7ffe2a2428df53565b106abe9a6a88d0edf2e5c4310a55"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.6.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8694118e67f4593dc3cdfde0a2bfbb10",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 12388,
                "upload_time": "2019-10-30T13:05:26",
                "upload_time_iso_8601": "2019-10-30T13:05:26.969970Z",
                "url": "https://files.pythonhosted.org/packages/ca/4f/2bb8869e4ab087d2ed8c1b3890aeb67a0f370bd5bbf5f8930265f770e10c/validate_docbr-1.6.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.6.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e778d73bbf036b63f375fc9e27dfe2f9",
                    "sha256": "3b6714dc0837aa187574c22bc65c00cd786d4b830c0abd765b2aee7164b70a4e"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.6.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e778d73bbf036b63f375fc9e27dfe2f9",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 12396,
                "upload_time": "2019-12-12T17:40:02",
                "upload_time_iso_8601": "2019-12-12T17:40:02.585653Z",
                "url": "https://files.pythonhosted.org/packages/12/36/f90ef67e08543f16ca12ece1e77346aa3c6b361047932fbbe616f3f3f6ac/validate_docbr-1.6.1-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.7.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0a1a0d7c5d2177740c6581a3ab9aecd6",
                    "sha256": "591edd93516a54801c9cef3c31cdbfee5a507eb14060449ee25cfacff0cfe882"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.7.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0a1a0d7c5d2177740c6581a3ab9aecd6",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 13857,
                "upload_time": "2020-05-04T05:02:04",
                "upload_time_iso_8601": "2020-05-04T05:02:04.080379Z",
                "url": "https://files.pythonhosted.org/packages/54/b1/848bcc9c02a3e92b0302a75e6a2db7311c2e1efc544490d3a2f7ee25f9df/validate_docbr-1.7.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.8.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4ce066941da22a9f587e1200a6e7aec5",
                    "sha256": "704847c230e2426b2c276e439f9cd053ba20bc9143f4cb2391e96dfbe31371bf"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.8.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4ce066941da22a9f587e1200a6e7aec5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 15363,
                "upload_time": "2020-10-10T04:20:14",
                "upload_time_iso_8601": "2020-10-10T04:20:14.544566Z",
                "url": "https://files.pythonhosted.org/packages/32/6e/fc4b59dbc817a9979438d110658c45ab5ed35d7a32f3502868bedf6ff2a3/validate_docbr-1.8.1-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.8.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a890d54b2227fe76ce0b05604a9dcb6e",
                    "sha256": "208287b8ec97e3dbc16fb8126c56f4e82d50b66f48e0cc262edc69d99da8a5fa"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.8.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a890d54b2227fe76ce0b05604a9dcb6e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 15681,
                "upload_time": "2020-10-23T18:48:09",
                "upload_time_iso_8601": "2020-10-23T18:48:09.702565Z",
                "url": "https://files.pythonhosted.org/packages/a6/ff/f68743b87156a375d33e278f081d6ab95793dda9bfae5f0fb4e376d426e5/validate_docbr-1.8.2-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "1.9.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "7a9281a767f26dd11cffb5f5f28aef81",
                    "sha256": "305d190b27a2abcde1e59aa6094f313f77ba183512d1bac29ccc76cea2568607"
                },
                "downloads": -1,
                "filename": "validate_docbr-1.9.0.tar.gz",
                "has_sig": false,
                "md5_digest": "7a9281a767f26dd11cffb5f5f28aef81",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11473,
                "upload_time": "2021-10-13T00:57:23",
                "upload_time_iso_8601": "2021-10-13T00:57:23.419246Z",
                "url": "https://files.pythonhosted.org/packages/be/d0/b9d67821dd495d87f802de2a9e3a5992e05244c57637468b9ec27dcc3dbe/validate_docbr-1.9.0.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "90d2f8bd1376a7c0472e5c4c0fefe571",
                "sha256": "ff016f180b0c5ecff06abce1d83385924438c4d4c7f5c050e90fb724f1d968bb"
            },
            "downloads": -1,
            "filename": "validate_docbr-1.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "90d2f8bd1376a7c0472e5c4c0fefe571",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 18814,
            "upload_time": "2021-10-26T19:35:20",
            "upload_time_iso_8601": "2021-10-26T19:35:20.444908Z",
            "url": "https://files.pythonhosted.org/packages/8b/0d/799d5c729efb85a8bd7786c7cb55780bb66f9c386ec805198e05d3fa0c80/validate_docbr-1.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "vulnerabilities": []
}