| Name | valida-doc JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Biblioteca para validação de documentos |
| upload_time | 2024-04-28 18:26:40 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License |
| keywords |
validar
documento
cpf
rg
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Validador de Documentos
Uma biblioteca de fácil uso para validar se um documento é válido ou não, considerando as regras de autenticidade de cada órgão expeditor daquele documento.
## Documentos disponíveis para validação
- CPF
- RG
- São Paulo
## Documentos em roadmap
- RG
- Rio de Janeiro
- Bahia
- Minas Gerais
- Goiáis
- Paraná
- Santa Catarina
- CNH
## Instalação
Para instalar basta utilizar o comando abaixo
```python
pip install valida_doc
```
## Validação de CPF
Abaixo coloco um exemplo de como poderá ser feita a validação de um CPF. Lembrando que sempre será necessário utilizar uma ```string``` para requisitar a validação.
```python
from valida_doc import cpf
forma1 = cpf("XXX.XXX.XXX-XX") # exemplo de como informar o CPF
forma2 = cpf("XXXXXXXXX-XX") # exemplo de como informar o CPF
forma3 = cpf("XXXXXXXXXXX") # exemplo de como informar o CPF
```
Caso sejam inseridos letras e símbolos será apresentado uma mensagem do tipo ```string``` informando o erro
Caso sejam inseridos quantidade maior ou menor de dígitos será apresentado uma mensagem do tipo ```string``` informando o erro
Se o CPF atender os padrões específicos, retornará ```True``` se for válido ou ```False``` se for inválido.
## Validação de RG (Apenas para São Paulo)
Abaixo coloco um exemplo de como poderá ser feita a validação de um SP para São Paulo. Lembrando que sempre será necessário utilizar uma ```string``` para requisitar a validação.
```python
from valida_doc import rg_sp
forma1 = rg_sp("XX.XXX.XXX-X") # exemplo de como informar o RG
forma2 = rg_sp("XXXXXXXX-X") # exemplo de como informar o RG
forma3 = rg_sp("XXXXXXXXX") # exemplo de como informar o RG
```
Caso sejam inseridos letras e símbolos será apresentado uma mensagem do tipo ```string``` informando o erro
Caso sejam inseridos quantidade maior ou menor de dígitos será apresentado uma mensagem do tipo ```string``` informando o erro
Se o rg atender os padrões específicos, retornará ```True``` se for válido ou ```False``` se for inválido.
## Informação Geral
Sempre haverá a retirada de símbolos como ```.``` e ```-```, não necessitando nenhum tipo de tratativa pelo usuário que irá consumir a biblioteca.
## Licença
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "valida-doc",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "validar documento cpf rg",
"author": null,
"author_email": "caseiro.gui@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/cd/a2/81f173e9e8cf50e99436f00719e9dda2b924b8d5bab220cf54baa2448ec1/valida_doc-0.0.1.tar.gz",
"platform": null,
"description": "# Validador de Documentos \r\n\r\nUma biblioteca de f\u00e1cil uso para validar se um documento \u00e9 v\u00e1lido ou n\u00e3o, considerando as regras de autenticidade de cada \u00f3rg\u00e3o expeditor daquele documento.\r\n\r\n## Documentos dispon\u00edveis para valida\u00e7\u00e3o\r\n\r\n- CPF\r\n- RG\r\n - S\u00e3o Paulo \r\n\r\n## Documentos em roadmap\r\n- RG\r\n - Rio de Janeiro\r\n - Bahia\r\n - Minas Gerais\r\n - Goi\u00e1is\r\n - Paran\u00e1\r\n - Santa Catarina\r\n- CNH\r\n\r\n## Instala\u00e7\u00e3o\r\nPara instalar basta utilizar o comando abaixo\r\n\r\n```python\r\npip install valida_doc\r\n```\r\n\r\n## Valida\u00e7\u00e3o de CPF\r\nAbaixo coloco um exemplo de como poder\u00e1 ser feita a valida\u00e7\u00e3o de um CPF. Lembrando que sempre ser\u00e1 necess\u00e1rio utilizar uma ```string``` para requisitar a valida\u00e7\u00e3o.\r\n\r\n```python\r\nfrom valida_doc import cpf\r\nforma1 = cpf(\"XXX.XXX.XXX-XX\") # exemplo de como informar o CPF\r\nforma2 = cpf(\"XXXXXXXXX-XX\") # exemplo de como informar o CPF\r\nforma3 = cpf(\"XXXXXXXXXXX\") # exemplo de como informar o CPF\r\n```\r\n\r\nCaso sejam inseridos letras e s\u00edmbolos ser\u00e1 apresentado uma mensagem do tipo ```string``` informando o erro\r\nCaso sejam inseridos quantidade maior ou menor de d\u00edgitos ser\u00e1 apresentado uma mensagem do tipo ```string``` informando o erro\r\n\r\nSe o CPF atender os padr\u00f5es espec\u00edficos, retornar\u00e1 ```True``` se for v\u00e1lido ou ```False``` se for inv\u00e1lido.\r\n\r\n## Valida\u00e7\u00e3o de RG (Apenas para S\u00e3o Paulo)\r\nAbaixo coloco um exemplo de como poder\u00e1 ser feita a valida\u00e7\u00e3o de um SP para S\u00e3o Paulo. Lembrando que sempre ser\u00e1 necess\u00e1rio utilizar uma ```string``` para requisitar a valida\u00e7\u00e3o.\r\n\r\n```python\r\nfrom valida_doc import rg_sp\r\nforma1 = rg_sp(\"XX.XXX.XXX-X\") # exemplo de como informar o RG\r\nforma2 = rg_sp(\"XXXXXXXX-X\") # exemplo de como informar o RG\r\nforma3 = rg_sp(\"XXXXXXXXX\") # exemplo de como informar o RG\r\n```\r\n\r\nCaso sejam inseridos letras e s\u00edmbolos ser\u00e1 apresentado uma mensagem do tipo ```string``` informando o erro\r\nCaso sejam inseridos quantidade maior ou menor de d\u00edgitos ser\u00e1 apresentado uma mensagem do tipo ```string``` informando o erro\r\n\r\nSe o rg atender os padr\u00f5es espec\u00edficos, retornar\u00e1 ```True``` se for v\u00e1lido ou ```False``` se for inv\u00e1lido.\r\n\r\n## Informa\u00e7\u00e3o Geral\r\nSempre haver\u00e1 a retirada de s\u00edmbolos como ```.``` e ```-```, n\u00e3o necessitando nenhum tipo de tratativa pelo usu\u00e1rio que ir\u00e1 consumir a biblioteca.\r\n\r\n\r\n## Licen\u00e7a\r\n\r\nMIT\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Biblioteca para valida\u00e7\u00e3o de documentos",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [
"validar",
"documento",
"cpf",
"rg"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cda281f173e9e8cf50e99436f00719e9dda2b924b8d5bab220cf54baa2448ec1",
"md5": "c12057f6380952037c098c1acfd8fcf6",
"sha256": "c6d9d1bcc18aafd630753178217d09a3cbf49ae7ec15182dcfc8a617f80f63a7"
},
"downloads": -1,
"filename": "valida_doc-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "c12057f6380952037c098c1acfd8fcf6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3292,
"upload_time": "2024-04-28T18:26:40",
"upload_time_iso_8601": "2024-04-28T18:26:40.700156Z",
"url": "https://files.pythonhosted.org/packages/cd/a2/81f173e9e8cf50e99436f00719e9dda2b924b8d5bab220cf54baa2448ec1/valida_doc-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 18:26:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "valida-doc"
}
