cuducos/calculadora-do-cidadao

Melhor experiência para testes e documentação em desenvolvimento

cuducos opened this issue · 2 comments

As instruções para rodar os testes, atualmente, passam pela instalação manual de alguns pacotes (tox, pytest e mais plugins).

Acredito que utilizando o Poetry a gente consiga simplificar essas instruções (e o processo todo) com:

A suíte de testes roda com diversas versões do Python via tox:

$ poetry run tox

Se quiser rodar os testes mais rapidamente apenas para a versão em uso, é possível utilizar o pytest:

$ poetry run pyetst

Ainda, simplificamos a parte de gerar documentação para apenas:

Para visualizar alterações na documentação, é preciso instalar alguns pacotes e utilizar a o Sphinx:

$ poetry run sphinx-build docs docs/_build

Depois, é só acessar docs/_build/index.html.

Vale notar que no #41 já é introduzido o requirements-development.txt (obrigado, @turicas!) para contornar esse mesmo problema, mas talvez o Poetry seja uma solução mais robusta.

Mais:

Migrando para o pyproject.toml descrito na PEP 517, e utilizando o Poetry conseguimos concentrar nesse novo arquivo o conteúdo de diversos outros desse repositório (requirements-development.txt, setup.cfg e setup.py), evitar problemas como o #45, e ainda termos builds determinísticos.

(do #46, fechado, para favorecer essa issue aqui)

Fechado pelo commit 0ec5178.