Este projeto foi desenvolvido utilizando FastAPI, uma moderna e rápida framework para construção de APIs com Python. A seguir, você encontrará informações sobre as tecnologias utilizadas, o passo a passo para rodar a aplicação, como executar os testes e onde encontrar mais informações sobre o desenvolvedor.
- FastAPI: Framework para criação de APIs com Python.
- Poetry: Gerenciador de dependências e ambientes virtuais.
- Alembic: Ferramenta de migrações para bancos de dados SQL.
- SQLAlchemy: Biblioteca de ORM para interação com bancos de dados SQL.
- JWT: Autenticação e autorização utilizando JSON Web Tokens.
- Ruff: Ferramenta de linting para código Python.
- Taskipy: Facilitador para execução de tasks definidas no
pyproject.toml. - Pydantic: Validação de dados baseada em tipos para Python.
- Pytest: Framework de testes para Python.
- Docker: Plataforma de containerização para criação de ambientes isolados.
- PostgreSQL: Foi utilizado com
psycopgcomo banco de dados da aplicação. - Entre outras.
Este projeto foi desenvolvido como parte de um curso gratuito do canal do YouTube do Eduardo Mendes, especialista em Python.
-
Instalar o Poetry:
curl -sSL https://install.python-poetry.org | python3 - -
Criar um Ambiente Virtual:
poetry shell
-
Instalar as Dependências:
poetry install
-
Executar as Migrações com Alembic:
alembic upgrade head
-
Rodar o Docker Compose: Na raiz do projeto, execute:
docker-compose up -d
Para rodar os testes da aplicação, utilize o comando:
task testA aplicação foi testada em um ambiente de deploy (fly.io) e está funcionando corretamente, embora atualmente não esteja online.
Para mais informações ou para entrar em contato, você pode me encontrar nas seguintes redes sociais:
Desenvolvido com ❤️ por Artur Peixoto.
Esse README.md oferece uma visão geral do projeto, as tecnologias utilizadas, instruções para configuração e execução, bem como informações de contato.