<p align="center">
<img src="https://raw.githubusercontent.com/matheusfelipeog/fordev/master/.github/assets/images/fordev.png" alt="Fordev - Gere e Valide Dados Randômicos" width="400px" />
</p>
<p align="center">
<sup>Metadata</sup>
<br />
<a href="https://pypi.org/project/fordev/">
<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/fordev" />
</a>
<a href="https://github.com/matheusfelipeog/fordev/blob/master/LICENSE">
<img alt="License MIT" src="https://img.shields.io/github/license/matheusfelipeog/fordev" />
</a>
<a href="https://pepy.tech/project/fordev">
<img alt="Total Downloads" src="https://pepy.tech/badge/fordev" />
</a>
</p>
<p align="center">
<sup>Status</sup>
<br />
<a href="https://pypi.org/project/fordev/">
<img alt="PyPI - Status" src="https://img.shields.io/pypi/status/fordev" />
</a>
<a href="https://fordev.readthedocs.io/pt_BR/latest/?badge=latest">
<img alt="Documentation Status" src="https://readthedocs.org/projects/fordev/badge/?version=latest" />
</a>
<a href="https://github.com/matheusfelipeog/fordev/actions/workflows/tests.yml">
<img alt="Test Status" src="https://github.com/matheusfelipeog/fordev/workflows/Tests/badge.svg" />
</a>
</p>
## Index
- [O objetivo](#o-objetivo)
- [Instalação](#instalação)
- [Demo](#demo)
- [Documentação Oficial](https://fordev.readthedocs.io/)
- [Funcionalidades](#funcionalidades)
- [fordev.generators](#fordevgenerators)
- [fordev.validators](#fordevvalidators)
- [Contribuições](#contribuições)
- [Aviso Legal](#aviso-legal)
- [Licença](#licença)
## O objetivo
O site [4Devs](https://4devs.com.br) disponibiliza diversas funcionalidades muito úteis para um desenvolvedor utilizar em seus projetos que necessitam de dados randômicos válidos e outras peculiaridades, tais como: dados dos principais documentos pessoais do brasil (CPF, CNPJ, CNH etc), dados bancários, dados de cartões de crédito, dados completos de pessoas (nome, idade, documentos, endereço etc) e muitos outros geradores de dados. Porém, até o momento, não possui uma interface/API pública para utiliza-los diretamente no código da aplicação em desenvolvimento, assim, sendo necessário ir buscar tais dados diretamente no site.
**Fordev** foi construído para resolver esse problema, disponibilizando um módulo de fácil uso que mapeia todo o site 4Devs usando técnicas de scraping, de modo que seja possível obter todos recursos disponíveis no site em um módulo Python.
## Instalação
Para instalar, certifique-se de que tenha [Python](https://www.python.org/) e o gerenciador de pacotes `pip` instalados em seu ambiente.
Instale com `pip`:
```bash
$ pip install fordev
```
> OBS: fordev precisa de acesso a internet para funcionar corretamente, certifique-se de que também a tenha
## Demo
Socilitando dados randômicos de uma pessoa do sexo *masculino*, de *25 anos de idade* e que *mora em SP*.
```python
>>> from fordev.generators import people
>>> people(sex='M', age=25, state='SP')
{
'altura': '1,90',
'bairro': 'Jardim Maria Amélia',
'celular': '(12) 98401-5301',
'cep': '12318-110',
'cidade': 'Jacareí',
'cor': 'laranja',
'cpf': '061.632.758-70',
'data_nasc': '06/12/1995',
'email': 'bentoyagolorenzogoncalves-72@alcastro.com.br',
'endereco': 'Rua José Benedito de Oliveira',
'estado': 'SP',
'idade': 25,
'mae': 'Tereza Melissa Priscila',
'nome': 'Bento Yago Lorenzo Gonçalves',
'numero': 760,
'pai': 'Sérgio Guilherme Erick Gonçalves',
'peso': 88,
'rg': '23.920.314-8',
'senha': 'ErOKUUyoml',
'sexo': 'Masculino',
'signo': 'Sagitário',
'telefone_fixo': '(12) 2844-9806',
'tipo_sanguineo': 'AB+'
}
```
Confira a seção de [funcionalidades](#funcionalidades) para ver todas as funções atualmente disponíveis no módulo **fordev**.
## Funcionalidades
Todas as funcionalidades disponíveis e que foram mapeadas no site 4Devs estão listados na tabela abaixo.
| Função | Tem gerador? | Tem validador? |
| :----: | :----------: | :------------: |
| **certificate** | ✔ | ✔ |
| **cnh** | ✔ | ✔ |
| **bank_account** | ✔ | ✔ |
| **pis_pasep** | ✔ | ✔ |
| **renavam** | ✔ | ✔ |
| **vehicle** | ✔ | ❌ |
| **vehicle_brand** | ✔ | ❌ |
| **vehicle_plate** | ✔ | ❌ |
| **cnpj** | ✔ | ✔ |
| **rg** | ✔ | ❌ |
| **state_registration** | ✔ | ✔ |
| **voter_title** | ✔ | ✔ |
| **credit_card** | ✔ | ✔ |
| **people** | ✔ | ❌ |
| **company** | ✔ | ❌ |
| **uf** | ✔ | ❌ |
| **city** | ✔ | ❌ |
Confira a [Documentação Oficial](https://fordev.readthedocs.io/) para mais detalhes.
## Contribuições
Toda contribuição é super bem-vinda!
Abaixo mostro com o que você pode contribuir:
- Encontrou algum bug, quer propor uma nova funcionalidade ou conversar sobre o projeto? [Abra uma Issue](https://github.com/matheusfelipeog/fordev/issues) e descreve seu caso.
- Existe uma issue aberta e você quer resolve-la, quer implementar uma nova funcionalidade ou melhorar a documentação? Faça suas adições e me envie um *Pull Request*
- Gostou do projeto, mas não quer ou ainda não consegue contribuir com ele? Considere deixar uma estrela ⭐ para o **Fordev**
Obrigado pelo interesse em colaborar de alguma forma com o projeto 😄
## Aviso Legal
Todo os dados são gerados de forma randômica, respeitando as regras de criação de cada tipo de dado.
Todo os dados gerados são para fins informativos e utilizados para auxiliar estudantes, programadores, analistas e testadores no desenvolvimento de softwares que necessitem de tais dados. Não devem ser considerados completos, atualizados, e não se destinam a ser utilizado no lugar de uma consulta jurídica, médica, financeira, ou de qualquer outro profissional. Todo e qualquer risco da utilização dos dados disponibilizados atráves do módulo **Fordev** é assumido pelo próprio usuário.
O aviso acima é uma adaptação para utilização no repositório, confira os termos de uso oficial do site 4Devs em: [Termos de Uso](https://www.4devs.com.br/termos_de_uso)
## Licença
**Fordev** utiliza a *licença MIT* em todo seu código, confira suas condições em [MIT License](https://github.com/matheusfelipeog/fordev/blob/master/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/matheusfelipeog/fordev",
"name": "fordev",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "fordev,4dev,4devs,4devs-api,4devs-module,fourthdev,python,api,scraping,data-generator,fake-data,fake-data-generator,data-manipulation,data-validation,random-data",
"author": "Matheus Felipe",
"author_email": "matheusfelipeog@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/31/e7/d241b01725336eadc6cadceb3142a4eb5d7017162614d637461c76dea01c/fordev-1.0.5.tar.gz",
"platform": null,
"description": "\n<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/matheusfelipeog/fordev/master/.github/assets/images/fordev.png\" alt=\"Fordev - Gere e Valide Dados Rand\u00f4micos\" width=\"400px\" />\n</p>\n\n<p align=\"center\">\n <sup>Metadata</sup>\n <br />\n <a href=\"https://pypi.org/project/fordev/\">\n <img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/fordev\" />\n </a>\n <a href=\"https://github.com/matheusfelipeog/fordev/blob/master/LICENSE\">\n <img alt=\"License MIT\" src=\"https://img.shields.io/github/license/matheusfelipeog/fordev\" />\n </a>\n <a href=\"https://pepy.tech/project/fordev\">\n <img alt=\"Total Downloads\" src=\"https://pepy.tech/badge/fordev\" />\n </a>\n</p>\n\n<p align=\"center\">\n <sup>Status</sup>\n <br />\n <a href=\"https://pypi.org/project/fordev/\">\n <img alt=\"PyPI - Status\" src=\"https://img.shields.io/pypi/status/fordev\" />\n </a>\n <a href=\"https://fordev.readthedocs.io/pt_BR/latest/?badge=latest\">\n <img alt=\"Documentation Status\" src=\"https://readthedocs.org/projects/fordev/badge/?version=latest\" />\n </a>\n <a href=\"https://github.com/matheusfelipeog/fordev/actions/workflows/tests.yml\">\n <img alt=\"Test Status\" src=\"https://github.com/matheusfelipeog/fordev/workflows/Tests/badge.svg\" />\n </a>\n</p>\n\n\n## Index\n\n- [O objetivo](#o-objetivo)\n- [Instala\u00e7\u00e3o](#instala\u00e7\u00e3o)\n- [Demo](#demo)\n- [Documenta\u00e7\u00e3o Oficial](https://fordev.readthedocs.io/)\n- [Funcionalidades](#funcionalidades)\n - [fordev.generators](#fordevgenerators)\n - [fordev.validators](#fordevvalidators)\n- [Contribui\u00e7\u00f5es](#contribui\u00e7\u00f5es)\n- [Aviso Legal](#aviso-legal)\n- [Licen\u00e7a](#licen\u00e7a)\n\n\n## O objetivo\n\nO site [4Devs](https://4devs.com.br) disponibiliza diversas funcionalidades muito \u00fateis para um desenvolvedor utilizar em seus projetos que necessitam de dados rand\u00f4micos v\u00e1lidos e outras peculiaridades, tais como: dados dos principais documentos pessoais do brasil (CPF, CNPJ, CNH etc), dados banc\u00e1rios, dados de cart\u00f5es de cr\u00e9dito, dados completos de pessoas (nome, idade, documentos, endere\u00e7o etc) e muitos outros geradores de dados. Por\u00e9m, at\u00e9 o momento, n\u00e3o possui uma interface/API p\u00fablica para utiliza-los diretamente no c\u00f3digo da aplica\u00e7\u00e3o em desenvolvimento, assim, sendo necess\u00e1rio ir buscar tais dados diretamente no site.\n\n**Fordev** foi constru\u00eddo para resolver esse problema, disponibilizando um m\u00f3dulo de f\u00e1cil uso que mapeia todo o site 4Devs usando t\u00e9cnicas de scraping, de modo que seja poss\u00edvel obter todos recursos dispon\u00edveis no site em um m\u00f3dulo Python.\n\n\n## Instala\u00e7\u00e3o\n\nPara instalar, certifique-se de que tenha [Python](https://www.python.org/) e o gerenciador de pacotes `pip` instalados em seu ambiente.\n\nInstale com `pip`:\n\n```bash\n$ pip install fordev\n```\n\n> OBS: fordev precisa de acesso a internet para funcionar corretamente, certifique-se de que tamb\u00e9m a tenha\n\n\n## Demo\n\nSocilitando dados rand\u00f4micos de uma pessoa do sexo *masculino*, de *25 anos de idade* e que *mora em SP*.\n\n```python\n>>> from fordev.generators import people\n>>> people(sex='M', age=25, state='SP')\n{\n 'altura': '1,90',\n 'bairro': 'Jardim Maria Am\u00e9lia',\n 'celular': '(12) 98401-5301',\n 'cep': '12318-110',\n 'cidade': 'Jacare\u00ed',\n 'cor': 'laranja',\n 'cpf': '061.632.758-70',\n 'data_nasc': '06/12/1995',\n 'email': 'bentoyagolorenzogoncalves-72@alcastro.com.br',\n 'endereco': 'Rua Jos\u00e9 Benedito de Oliveira',\n 'estado': 'SP',\n 'idade': 25,\n 'mae': 'Tereza Melissa Priscila',\n 'nome': 'Bento Yago Lorenzo Gon\u00e7alves',\n 'numero': 760,\n 'pai': 'S\u00e9rgio Guilherme Erick Gon\u00e7alves',\n 'peso': 88,\n 'rg': '23.920.314-8',\n 'senha': 'ErOKUUyoml',\n 'sexo': 'Masculino',\n 'signo': 'Sagit\u00e1rio',\n 'telefone_fixo': '(12) 2844-9806',\n 'tipo_sanguineo': 'AB+'\n}\n```\n\nConfira a se\u00e7\u00e3o de [funcionalidades](#funcionalidades) para ver todas as fun\u00e7\u00f5es atualmente dispon\u00edveis no m\u00f3dulo **fordev**.\n\n\n## Funcionalidades\n\nTodas as funcionalidades dispon\u00edveis e que foram mapeadas no site 4Devs est\u00e3o listados na tabela abaixo.\n\n| Fun\u00e7\u00e3o | Tem gerador? | Tem validador? |\n| :----: | :----------: | :------------: |\n| **certificate** | \u2714 | \u2714 |\n| **cnh** | \u2714 | \u2714 |\n| **bank_account** | \u2714 | \u2714 |\n| **pis_pasep** | \u2714 | \u2714 |\n| **renavam** | \u2714 | \u2714 |\n| **vehicle** | \u2714 | \u274c |\n| **vehicle_brand** | \u2714 | \u274c |\n| **vehicle_plate** | \u2714 | \u274c |\n| **cnpj** | \u2714 | \u2714 |\n| **rg** | \u2714 | \u274c |\n| **state_registration** | \u2714 | \u2714 |\n| **voter_title** | \u2714 | \u2714 |\n| **credit_card** | \u2714 | \u2714 |\n| **people** | \u2714 | \u274c |\n| **company** | \u2714 | \u274c |\n| **uf** | \u2714 | \u274c |\n| **city** | \u2714 | \u274c |\n\nConfira a [Documenta\u00e7\u00e3o Oficial](https://fordev.readthedocs.io/) para mais detalhes.\n\n\n## Contribui\u00e7\u00f5es\n\nToda contribui\u00e7\u00e3o \u00e9 super bem-vinda!\n\nAbaixo mostro com o que voc\u00ea pode contribuir:\n\n- Encontrou algum bug, quer propor uma nova funcionalidade ou conversar sobre o projeto? [Abra uma Issue](https://github.com/matheusfelipeog/fordev/issues) e descreve seu caso.\n\n- Existe uma issue aberta e voc\u00ea quer resolve-la, quer implementar uma nova funcionalidade ou melhorar a documenta\u00e7\u00e3o? Fa\u00e7a suas adi\u00e7\u00f5es e me envie um *Pull Request*\n\n- Gostou do projeto, mas n\u00e3o quer ou ainda n\u00e3o consegue contribuir com ele? Considere deixar uma estrela \u2b50 para o **Fordev**\n\nObrigado pelo interesse em colaborar de alguma forma com o projeto \ud83d\ude04\n\n\n## Aviso Legal\n\nTodo os dados s\u00e3o gerados de forma rand\u00f4mica, respeitando as regras de cria\u00e7\u00e3o de cada tipo de dado. \n\nTodo os dados gerados s\u00e3o para fins informativos e utilizados para auxiliar estudantes, programadores, analistas e testadores no desenvolvimento de softwares que necessitem de tais dados. N\u00e3o devem ser considerados completos, atualizados, e n\u00e3o se destinam a ser utilizado no lugar de uma consulta jur\u00eddica, m\u00e9dica, financeira, ou de qualquer outro profissional. Todo e qualquer risco da utiliza\u00e7\u00e3o dos dados disponibilizados atr\u00e1ves do m\u00f3dulo **Fordev** \u00e9 assumido pelo pr\u00f3prio usu\u00e1rio.\n\nO aviso acima \u00e9 uma adapta\u00e7\u00e3o para utiliza\u00e7\u00e3o no reposit\u00f3rio, confira os termos de uso oficial do site 4Devs em: [Termos de Uso](https://www.4devs.com.br/termos_de_uso)\n\n\n## Licen\u00e7a\n\n**Fordev** utiliza a *licen\u00e7a MIT* em todo seu c\u00f3digo, confira suas condi\u00e7\u00f5es em [MIT License](https://github.com/matheusfelipeog/fordev/blob/master/LICENSE).\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Gere e valide dados rand\u00f4micos com fordev",
"version": "1.0.5",
"split_keywords": [
"fordev",
"4dev",
"4devs",
"4devs-api",
"4devs-module",
"fourthdev",
"python",
"api",
"scraping",
"data-generator",
"fake-data",
"fake-data-generator",
"data-manipulation",
"data-validation",
"random-data"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "b9e4c6a3a4e0e28cd9e0a5f77c37d032",
"sha256": "a3dc3fa100f12acc2891c45c4685046aedcfcf8b8ac6e6f33efaf9745e2859da"
},
"downloads": -1,
"filename": "fordev-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9e4c6a3a4e0e28cd9e0a5f77c37d032",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 29650,
"upload_time": "2022-12-24T02:52:50",
"upload_time_iso_8601": "2022-12-24T02:52:50.666427Z",
"url": "https://files.pythonhosted.org/packages/bf/e4/f1acf1e57bf9ae0054f86152f2b0f52a33e46d1ab57da710325036dcc302/fordev-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "d2786ba114f4d179ad6533aa49a5e2e1",
"sha256": "fd5cbd867b17e412844d203fc4b952b7145af9648dc4e05042f693190f5eb13c"
},
"downloads": -1,
"filename": "fordev-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "d2786ba114f4d179ad6533aa49a5e2e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19194,
"upload_time": "2022-12-24T02:52:52",
"upload_time_iso_8601": "2022-12-24T02:52:52.135683Z",
"url": "https://files.pythonhosted.org/packages/31/e7/d241b01725336eadc6cadceb3142a4eb5d7017162614d637461c76dea01c/fordev-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-24 02:52:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "matheusfelipeog",
"github_project": "fordev",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fordev"
}
JSON
