docs

2022-2-Certifik8

Certifik8

Gerador Automatico de Certificados
Documentos - Reportar Bug - Recomendar Feature

Conteúdo

1. 📝 Especificações Técnicas
2. ⚙️ Funcionamento
3. 💻 Como Utilizar
4. 📈 Métricas

📝 Especificações Técnicas

Linguagem:

Versão: 3.10

Bibliotecas para Executar as Funcionalidades:

• Pandas: 1.5.2
• Setuptools: 65.6.3
• Pillow: 9.3.0
• PyPDF2: 2.11.1
• Pdfkit: 1.0.0
• Beautifulsoup4: 4.11.1
• Openpyxl: 3.0.10
• Tqdm: 4.64.1

Biblioteca para Criação do Ambiente Virtual e Gestão de Pacotes:

• Poetry: 1.3.2

Bibliotecas para Cobrimento de Testes

• Pytest: 7.2.1
• Coverage: 7.1.0

Diagrama de Arquivos

Onde se está dispovível para Utilização:

• Linux Mint 21
• Ubuntu 22.04.01

⚙️ Funcionamento

O funcionamento do Certifik8 segue as seguintes etapas:

1. Escolha de um ou mais arquivos .xlsx
2. Escolha da Pasta de destino final dos certificados
3. Geração dos Certificados separadas em subpastas de acordo com a função no evento

💻 Como Utilizar

1. Clone o repositório

git clone https://github.com/fga-eps-mds/2022-2-Certifik8.git

2. Para instalar as dependências no ambiente virtual, rode os comandos:

poetry install

3 Comando para acessar tutorial da aplicação

poetry run certifik8 --h

4 Comando para rodar a aplicação

poetry run certifik8

5 Comando para rodar os Testes

pytest --cov-config=.coveragerc --cov=Certifik8

📈 Métricas

Para gerenciamento das métricas de manutenrabilidade e de cobertura de testes, se esta utiliando o Code Climate.