Ir para o conteúdo

Ambiente

Configuração

Parâmetro Descrição Default
debug Habilita a saída dos logs de depuração false
logging_file Habilita o salvamento dos registros dos logs em arquivo. Isso criará uma pasta .logs false
host Vincula o soquete a este endereço de host.
Defina 0.0.0.0 para tornar a aplicação disponível em sua rede local		 127.0.0.1
port Vincula a um soquete e executa a aplicação com esta porta 8000
reload Habilita o recarregamento automático da aplicação quando os arquivos são modificados false

Você pode configurar alguns parâmetros para a aplicação no arquivo pyproject.toml, tais como:

pyproject.toml
81
82
83
84
85
86
[application]
debug = false
logging_file = false
host = "127.0.0.1"
port = 8000
reload = false

Você também pode definir variáveis de ambiente para substituir as configurações padrão ao executar a aplicação localmente ou em um contêiner Docker.

.env
1
2
3
4
5
6
7
8
9
DEBUG=false

LOGGING_FILE=false

HOST=127.0.0.1

PORT=8000

RELOAD=false

Ambiente Python

É necessário preparar um ambiente com as dependências corretas para trabalhar corretamente com cada área da aplicação. Para fazer isso, você precisa instalar o Python3 v3.11 com Venv e Pip.

Info

Este projeto usa o Poetry para empacotar e gerenciar dependências do Python.

Tip

Você também pode usar Docker para executar a aplicação.

Configurar o Ambiente Virtual

# Configure o Venv
make setup

# Ative o Venv
source .venv/bin/activate

Dependências

Ambiente Completo

Instale todas as dependências.

(.venv) poetry install

(.venv) pip3 install -r requirements/requirements-all.txt

Ambiente da Aplicação

Instale apenas as dependências da aplicação.

(.venv) make install

(.venv) pip3 install -r requirements/requirements.txt


Execute a aplicação

# Execute a aplicação Localmente
(.venv) make run

# Execute a aplicação em um Contêiner Docker
make docker

Ambiente de Desenvolvimento

Instale apenas as dependências de desenvolvimento.

(.venv) poetry install --only dev

(.venv) pip3 install -r requirements/requirements-dev.txt


Execute a Formatação, o Linting e a Auditoria de Vulnerabilidades.

# execute a Formatação
(.venv) make format

# execute o Linting
(.venv) make lint

# execute o Linting nos Testes
(.venv) make lint-tests

# execute a Auditoria de Vulnerabilidades
(.venv) make audit

Ambiente dos Testes

Instale apenas as dependências dos testes.

(.venv) poetry install --only test

(.venv) pip3 install -r requirements/requirements-test.txt


Execute os testes e verifique a cobertura dos testes

# Execute o Pytest no Venv
(.venv) make test

# Execute o Coverage no Venv
(.venv) make coverage

# Execute o Pytest no Docker
make test-docker

# Execute o Coverage no Docker
make coverage-docker

Ambiente da Documentação

Instale apenas as dependências da documentação.

(.venv) poetry install --only docs

(.venv) pip3 install -r requirements/requirements-docs.txt


Execute a documentação do Mkdocs.

Execute Localmente e acesse a página web em http://127.0.0.1:8000.

# Servir MkDocs
(.venv) make docs

Arquivos de Requisitos

Você pode gerar vários arquivos de requisitos para diferentes finalidades.

# Requisitos apenas para as dependências da Aplicação
(.venv) make req

# Requisitos para a Aplicação com as dependências de Desenvolvimento
(.venv) make req-dev

# Requisitos para as dependências da Documentação
(.venv) make req-docs

# Requisitos para as dependências dos Testes
(.venv) make req-test

# Requisitos para Todas as dependências
(.venv) make req-all