Skip to content

Instalação

Este guia irá orientá-lo na instalação e configuração inicial da API de Gerenciamento de Carros.

Clonando o Repositório

Primeiro, clone o repositório para sua máquina local:

git clone <URL_DO_REPOSITORIO>
cd car_api

Se você já tem o código-fonte localmente, navegue até o diretório do projeto:

cd /caminho/para/car_api

Instalando as Dependências

O projeto utiliza Poetry para gerenciamento de dependências. Instale todas as dependências com o comando:

poetry install

Se você quiser instalar apenas as dependências principais (sem as de desenvolvimento):

poetry install --no-dev

Ativando o Ambiente Virtual

Para trabalhar com o ambiente virtual criado pelo Poetry:

poetry shell

Alternativamente, você pode executar comandos dentro do ambiente virtual sem ativá-lo:

poetry run python script.py

Configurando o Banco de Dados

O projeto utiliza SQLite como banco de dados padrão. Para inicializar o banco de dados:

  1. Execute as migrações do Alembic:
poetry run alembic upgrade head

Isso criará as tabelas necessárias no banco de dados.

Executando a Aplicação

Para iniciar a API em modo de desenvolvimento:

poetry run fastapi dev car_api/app.py

Ou, alternativamente:

poetry run uvicorn car_api.app:app --reload --host 0.0.0.0 --port 8000

Por padrão, a API estará disponível em http://127.0.0.1:8000.

Verificando a Instalação

Após iniciar a aplicação, você pode verificar se tudo está funcionando corretamente acessando:

  • http://127.0.0.1:8000/health_check - Endpoint de saúde da aplicação
  • http://127.0.0.1:8000/docs - Documentação interativa da API (Swagger UI)
  • http://127.0.0.1:8000/redoc - Documentação alternativa (ReDoc)

Executando os Testes

Para garantir que tudo está configurado corretamente, execute os testes:

poetry run pytest

Problemas Comuns

Erro de Versão do Python

Certifique-se de estar usando Python 3.13 ou superior:

python --version

Se estiver usando uma versão diferente, você pode especificar a versão para o Poetry:

poetry env use python3.13
poetry install

Permissões de Arquivo

Em sistemas Unix/Linux/macOS, verifique as permissões dos arquivos:

chmod +x alembic.ini

Falha na Instalação de Dependências

Se ocorrerem erros durante a instalação das dependências, tente limpar o cache do Poetry:

poetry cache clear pypi --all
poetry install

Próximos Passos

Agora que a instalação está concluída, você pode: