Este projeto tem como objetivo analisar a qualidade de código, arquitetura e lógica de programação.
Para instalar o projeto, execute o seguinte comando:
make scaffoldPara rodar o projeto, utilize o seguinte comando:
make build
Esse comando irá construir os containers docker necessário para executar a aplicação.
O projeto inclui um conjunto de pacotes para verificar a qualidade do código. Para executar as ferramentas de linting, use:
make lint
Isso garante que o código esteja em conformidade com as melhores práticas e padrões de codificação.
Para facilitar diversos processos, o projeto inclui um arquivo Makefile. Você pode visualizar todas as funcionalidades disponíveis digitando o seguinte comando no terminal:
make
Aqui estão uma lista das funcionalidades disponíveis:
| Comando | Descrição |
|---|---|
scaffold |
Inicia a configuração do projeto |
alembic |
Cria arquivos de configuração |
start |
Inicia todos os containers |
build |
Constrói todos os containers sem desanexar |
stop |
Para todos os containers |
container |
Acessa o container |
migration |
Cria as migrations |
migrate |
Executa a migration no banco de dados |
pylint-generate |
Gera o arquivo de configuração do pylint |
lint |
Executa todas as ferramentas de linting |
test |
Executa os testes com Pytest dentro do container |
flake |
Executa o Flake8 |
black |
Executa o Black |
isort |
Executa o Isort |
autoflake |
Executa o Autoflake |
pylint |
Executa o Pylint |
É possível realizar a depuração do projeto. Se você estiver utilizando o Visual Studio Code, siga estes passos:
- Clique no botão "Run and Debug" na barra lateral do programa.
- Clique no botão "Start Debugging".
Certifique-se de que o Docker está em execução. Depois, defina um breakpoint e observe a depuração do código em tempo real.
O projeto utiliza as seguintes bibliotecas: