CLEAN ARCHITECTURE CRUD API

Este projeto refere-se a CRUD simples sendo uma API REST construída em Python usando o framework Flask para a criação dos endpoints. No entanto, a regra de negócio é completamente independente do framework, pois neste projeto foram implementadas regras da Clean Architecture (Arquitetura Limpa) estabelecidas por Robert Cecil Martin.

Para este projeto foram utilizadas algumas bibliotecas interessantes, tanto para a construção da aplicação quanto para a estilização do código. Abaixo estão as bibliotecas mais relevantes:

• pylint
• pytest
• pre-commit
• black
• flake8
• SQLAlchemy

Guia de uso

Com docker compose

Caso queira usar este projeto por meio do doker, faça alterações necesárias:

No arquivo .env:

HOST=db # Aqui deve ser db, pois é o mesmo bome dado lá no docker-compose.yml
USER_DATABASE= Your database user
PASSWORD= Your database password
PORT= Your database port
DATABASE= Your name database
JWT_SECRET_KEY= Your JWT_SECRET_KEY
REDIS_HOST= #Aqui substitua localhost por redis, ficando redis://redis:your port

Sem docker

Antes de continuar, é relevante informar que este repositório utiliza um banco de dados MySQL, mas é possível utilizar qualquer outro banco relacional, bastando realizar as configurações de conexão necessárias na infraestrutura do projeto. Para configurar essas conexões, recomenda-se consultar a documentação do SQLAlchemy para identificar as práticas corretas.

Após clonar o projeto, certifique-se de ter um virtualenv em sua máquina para assim instalar as dependências desta aplicação:

Instalação de dependências:

pip3 install -r requirements.txt

Configure de variáveis de ambiente .env baseando-se no .env_exemple:

HOST= Your database host
USER_DATABASE= Your database user
PASSWORD= Your database password
PORT= Your database port
DATABASE= Your name database
JWT_SECRET_KEY= Your JWT_SECRET_KEY
REDIS_HOST= Your redis hosts

Abra o seu gerenciador de banco de dados e crie o bnco de dados com o seguinte comando SQL:

CREATE DATABASE IF NOT EXISTS user_database;