certifik8 0.2.3

Certifik8 é um gerador de certificados automático criado em Python. O projeto busca facilitar a geração massiva de documentos a serem emitidos após algum evento.

2022-2-Certifik8

Certifik8

Gerador Automatico de Certificados
Documentos - Reportar Bug - Recomendar Feature

Conteúdo

1. 📝 Sobre o projeto
   • 💻 Tecnologias
2. 🤖 Funcionalidade
3. ❗ Requisitos
4. 🛞 Como executar
   • 👩‍🦰 Usuário
   • 🧙🏼‍♀️ Desenvolvimento local
5. 👨‍💻 Desenvolvedores

📝 Sobre o projeto

Certifik8 é um gerador de certificados automático criado em Python. O projeto busca facilitar a geração massiva de documentos a serem emitidos após algum evento ou curso na Semana Universitária da UnB.

💻 Tecnologias

Tecnologias utilizadas neste projeto:

🤖 Funcionalidade

O Certifik8 precisa apenas que o usuário escolha uma tabela excel .xlsx em algum de seus arquivos para em seguida escolher o local na qual a pasta com os certificados, de modelo já definido, ficarão salvos. Após essa escolha, a geração dos certificados em formato PDF acontece de forma que cada tabela escolhida possua uma pasta homônima no destino escolhido e cada pasta apresente subpastas que vão filtrar os participantes do evento de acordo com suas funções.

Exemplo:

❗ Requisitos

O Certifik8 só funciona em sistemas operacionais Linux.

Testado no:

• Linux Mint 21
• Ubuntu 22.04.01

Para conseguir executá-lo, o usuário precisa instalar:

• Python3 e Pip

  sudo apt install python3 && sudo apt install python3-pip
  

🛞 Como executar/rodar

- 👩‍🦰 Usuário

1. Abra seu terminal e digite o comando para instalar o Certifik8 do Pypi:

pip install certifik8

2. Comando para instalar as dependências não presentes no Pypi

certifik8 --install

3. Comando para acessar tutorial da aplicação

certifik8 --h

4. As tabelas dos cursos devem seguir uma padronização, caso contrário elas não irão gerar certificados:

• Estrutura da tabela Excel (Exemplo):

1	Nome	CPF	Função	Frequência	Informações
2	Samuel Barbosa Alves	729.334.326-41	PARTICIPANTE	100	Nome do Curso
3	Melissa Ribeiro Araujo	201.544.482-30	MONITOR	97	Carga Horaria
4	Gabrielly Rodrigues Castro	451.016.912-40	PARTICIPANTE	80	Nome do Professor
5	...	...	...	...	Nome do Departamento
6	...	...	...	...	Data Inicial
7	...	...	...	...	Data Final
8	...	...	...	...	Nome Decano(a)
...	...	...	...	...

*Obs.: As tabelas devem possuir essas cinco colunas com os mesmos nomes e em qualquer ordem. A coluna informações deve possuir seis linhas, e seus dados devem seguir a ordem da tabela de exemplo abaixo

5. Comando para rodar a aplicação

certifik8

6. Selecione as tabelas que possuem as informações do certificado:

7. Selecione a pasta onde deseja guardar os certificados:

- 🧙🏼‍♀️ Desenvolvimento local

1. Clone o repositório

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

2. Para instalar as dependências não advindas do Pypi, abra o repositório em seu computador e rode o comando:

cd Certifik8/installer

./dependencies.sh

2. Para instalar as dependências no ambiente virtual, rode o comando no diretório raiz:

poetry install

3 Para acessar tutorial da aplicação, rode o comando no diretório raiz:

poetry run certifik8 --h

4 Para rodar a aplicação no diretório raiz:

poetry run certifik8

👨‍💻 Desenvolvedores

Pedro Sampaio

Pedro Henrique

Victório Lazaro

Daniel Sousa

Leandro Silva

Geovane Freitas