Configuração do Ambiente

Este guia explica como configurar o ambiente para executar e desenvolver a API iaEditais.

Pré-requisitos

Antes de começar, certifique-se de ter os seguintes requisitos instalados:

• Python 3.7 ou superior - pipx para instalar pacotes Python isoladamente
• Poetry para gerenciamento de dependências
• Docker (opcional, para execução em contêiner)

Instalação de Dependências

1. Instale o pipx:

   pip install pipx
   

2. Use o pipx para instalar o poetry:

   pipx install poetry
   

3. Instale as dependências do projeto:

   poetry install
   

4. Ative o ambiente virtual:

   poetry shell
   

Executando o Projeto

Após configurar o ambiente, siga os passos abaixo para executar o projeto localmente:

1. Inicie a aplicação:

   task run
   

2. Acesse a documentação da API no navegador:

   • Swagger UI: http://localhost:8000/docs
   • Redoc: http://localhost:8000/redocs

Executando com Docker

Caso prefira executar o projeto em um contêiner Docker, siga as instruções abaixo:

1. Construa a imagem Docker:

   docker build -t iaeditais .
   

2. Inicie o contêiner:

   docker run -p 8000:8000 iaeditais
   

3. Acesse a documentação da API no navegador:

   • Swagger UI: http://localhost:8000/docs
   • Redoc: http://localhost:8000/redocs

Testes e Qualidade de Código

Para garantir a qualidade do código, utilize as ferramentas de lint e testes antes de contribuir:

1. Execute os testes automatizados:

   task test
   

Contribuição

Contribuições são bem-vindas! Para colaborar:

1. Faça um fork do repositório
2. Crie uma branch para suas alterações
3. Envie um pull request para análise

Se encontrar problemas ou tiver sugestões, abra uma issue no repositório.