A ideia desse projeto é já ser um "start" para seu projeto python. O que temos aqui são configurações pré prontas para que você possa se dedicar inteiramente ao código do seu projeto.

O Pipfile já tráz algumas dependencias de desenvolvimento, como:

asynctest = "==0.12.1"
pytest = "==4.0.1"
pytest-cov = "==2.6.0"
codecov = "==1.0.0"
mypy = "==0.630"
black = "==18.9b0"
isort = "==4.3.15"

Trás também script já pronto para checagem do código:

Já temos o comando para rodar os testes dos seu código com report de cobertura.

pipenv run test

Já temos um script pronto que roda o mypy, para fazer análise estátia no seu código. Muito útil para quem já usa type hints.

pipenv run lint

Usamos o black para formatar o código na tentativa de terminar com as discussões sobre fomatação. Deixe a formatação para um formatador e concentre-se na lógica do código. =D

pipenv run fmt para efetivamente formatar o código. Recomendado rodar a cada save ou antes de comitar. pipenv run fmt-check para colocar no seu pipeline, pois caso algum código esteja fora do padrão de formatação fará o build falhar.

Usamos o isort para ordenar os imports do seu código. Os parâmetros do isort geram uma formatação compatível com o black. Dessa forma podemos rodar os dois e eles concordarão em relação à versão final do código formatado.

pipenv run isort para ordenar os imports. pipenv run isort-check para checar se existe algum import fora do lugar, útil para colocar em seu pipeline.

Esse repositorio já possui alguns workflows do Github Actions pré-configurados. Os workflows são:

• .github/workflows/pull-request.yaml

  Esse workflow roda em cada PR aberto no projeto. Roda os testes em múltiplas versões do python e faz checagem de formatação de código, lint (com mypy) e formatação de imports (com isort).

  Esse workflow faz também upload do relatório de coverage para o codeclimate. Perceba que o upload é feito em apenas um versão do python, isso porque o codeclimate rejeita múltiplos upload para um mesmo commit, então precisamos escolher uma das rodadas de teste para fazer o upload.

Para facilitar na criação de um novo serviço e seguindo as boas práticas definidas no 12factors sobre configurações. Adicionamos o uso no pydantic para criar e validar essas informações para nós.

Exemplo de uso:

    from config import settings

    print(settings.DEBUG)

Para configurar uma variável de ambiente é necessário ficar atento ao prefixo. o default do projeto verificar inicialmente para uma variável de ambiente chamada NAMESPACEcaso não a encontre o prefixo será DEV_, o que isso significa?

O uso ficará da seguinte forma quando configuramos o namespace sempre adicionaremos o prefixo no momento de exportar as variaveis de ambiente.

    NAMESPACE=PROD PROD_DEBUG=False python main.py

Caso não definimos nenhum namespace, o prefixo será DEV, ou seja

    DEV_REDIS_PORT=1234 python main.py

Lembrando que dentro da sua aplicação o que vale é justamente o nome que foi definido no arquivo config.py, sem o prefixo.