gerval 0.0.1
Gerador & Validador de dados
License: MIT License
Keywords: gerval,gerador,validador

<div id="título" align="center">
    <img width="400px" alt="Gerval - Gerador & Validador" src=".github/assets/images/logo-nome.png"/>
</div>


---


<h2 id="índice" align="left">📌 Índice</h2>

<ul id="lista-índice" align="left">
    <li><a href="#objetivo">Objetivo</a></li>
    <li><a href="#instalação">Instalação</a></li>
    <li><a href="#demonstração">Demonstração</a></li>
    <li><a href="#funcionalidades">Funcionalidades</a></li>
    <li><a href="#contribuições">Contribuições</a></li>
    <li><a href="#aviso-legal">Aviso Legal</a></li>
    <li><a href="#licença">Licença</a></li>
</ul>



<h2 id="objetivo" align="left">🎯 Objetivo</h2>

<p id="txt-contribuições" align="left">
    O <strong>Gerval</strong> é uma aplicação que disponibiliza diversas funcionalidades com o intuito de auxiliar os desenvolvedores nos projetos que necessitam da geração de dados randômicos válidos dos principais documentos pessoais do Brasil, bem como sua validação. Além do mais, o software trata cifras, criptografias, manipulação de strings e outras peculiaridades. Com o mínimo de configuração, o Gerval pode ser utilizado como uma ferramenta de linha de comando para operações simples e rápidas ou sendo implementada diretamente no código-fonte como um módulo Python. 
</p>



<h2 id="instalação" align="left">🔧 Instalação</h2>

Para clonar o projeto para sua máquina via [git](https://git-scm.com/), utilize os seguintes comandos:

```shell
$ mkdir Gerval && cd Gerval
$ git clone https://github.com/dev-macb/Gerval
$ pip install -r requirements.txt
$ py ./Source/Principal.py
``` 

Caso deseja instalar a *lib* do Gerval para utilizar apenas como módulo em seu código-fonte, instale utilizando o gerenciador de pacotes `pip`. Certifique-se de que tenha [Python](https://www.python.org/) instalado em sua máquina.

```shell
$ pip install gerval
```
Caso deseja utilizar o Gerval como uma **CLI** nativa no seu terminal, baixe a [última *release*]() do projeto e execute o arquivo `setup.py` para reazlizar a configuração e a instalação da *cli* em sua máquina. Para verificar se está funcionando corretamente execute os passos da demonstração abaixo. Caso não funcione corretamente acesse a [documentação]() do Gerval para mais informações.


<h2 id="demonstração" align="left">💻 Demonstração</h2>

Socilitando dados randômicos de uma pessoa do sexo *masculino*, de *25 anos de idade* e que *mora em GO* via linha de comando e do módulo gerval no Python IDLE, respectivamente.

<div id="demonstrações" align="center">
    <img src=".github/assets/images/logo.png" alt="Fordev - Gere e Valide Dados Randômicos" width="400px"/>
    <br/>
    <img src=".github/assets/images/logo.png" alt="Fordev - Gere e Valide Dados Randômicos" width="400px"/>
</div>

<h2 id="funcionalidades" align="left">⚙️ Funcionalidades</h2>

<p id="txt-funcionalidades" align="left">
    O <strong>Gerval CLI</strong> disponibiliza geradores, validadores, cifradores, decifradores, criptografador, descriptografador e manipulador de strings usando comandos no shell via linha de comando. As operações da <em>cli</em> são realizadas através das funções do módulo <code>gerval</code> que pode ser implementado em códigos Python. As classes da <em>lib</em> são:
    <ul id="lista-modulos-pacote" align="left">
        <li><code>gerval.gerar</code> O módulo que contém as funções de geração de dados aleatoriamente.</li>
        <li><code>gerval.validar</code> O módulo que contém as funções de validação de dados.</li>
        <li><code>gerval.cifrar</code> O módulo que contém as funções de cifragem de mensagens.</li>
        <li><code>gerval.decifrar</code> O módulo que contém as funções de decifragem de mensagens.</li>
        <li><code>gerval.criptografar</code> O módulo que contém as funções de criptografia de mensagens.</li>
        <li><code>gerval.descriptografar</code> O módulo que contém as funções de descriptografia de mensagens.</li>
        <li><code>gerval.manipular</code> O módulo que contém as funções de manipulação de strings.</li>
    </ul>
    <blockquote>
        Para visualizar a documentação oficial com todas as funções e informações adicionais do módulo clique <a href="">aqui</a>.
    </blockquote>
</p>



<h2 id="contribuições" align="left">✒️ Contribuições</h2>

<p id="txt-contribuições" align="left">
    Toda contribuição será bem-vinda! Caso tenha encontrado algum bug, propor uma nova funcionalidade ou conversar sobre o projeto <a href="https://github.com/dev-macb/Gerval/issues">Abra uma Issue</a> e descreva seu caso. Se houver uma issue aberta e você deseja resolve-la, adicionar uma nova funcionalidade ou melhorar a documentação, desenvolva suas adições e me envie um <em>Pull Request</em>. Gostou do projeto e ainda não consegue contribuir com ele? Considere deixar uma ⭐ para o <strong>Gerval</strong>. Desde já agradeço pelo interesse em colaborar de alguma forma com o nosso projeto.
</p>



<h2 id="aviso-legal" align="left">📜 Aviso Legal</h2>

<p id="txt-aviso-legal" align="left">
    Os dados gerados pelo Gerval tem por finalidade auxiliar estudantes, programadores, analistas, testadores e hackers no desenvolvimento de softewares que necessitam de dados gerados de forma randômica, respeitando regras/cálculo de criação de cada tipo de dado dos principais documentos pessoais do Brasil. Todo e qualquer risco da utilização dos dados disponibilizados através do módulo e da cli é assumido pelo próprio usuário. Nesse sentido, <strong>NÃO</strong> 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.
</p>



<h2 id="licença" align="left">📄 Licença</h2>

<p id="txt-licença" align="left">
    O Gerval utiliza a <strong>licença MIT</strong> em todo seu código, confira suas condições em <a href="https://github.com/dev-macb/Gerval/blob/main/LICENSE">MIT License</a>.
</p>