calculadora-do-cidadao 0.5.1

Tool for Brazilian Reais monetary adjustment/correction

Calculadora do Cidadão

Pacote em Python para correção de valores. Confira a documentação para mais detalhes!

Exemplo de uso

In [1]: from datetime import date
   ...: from decimal import Decimal
   ...: from calculadora_do_cidadao import Ipca

In [2]: ipca = Ipca()

In [3]: ipca.adjust(date(2018, 7, 6))
Out[3]: Decimal('1.051202206630561280035407253')

In [4]: ipca.adjust("2014-07-08", 7)
Out[4]: Decimal('9.407523138792336916983267321')

In [5]: ipca.adjust("12/07/1998", 3, "01/07/2006")
Out[5]: Decimal('5.279855889296777979447848574')

Mini-guia de contribuição

O pacote utiliza o padrão pyproject.toml e o Poetry. Para instalar as dependências:

$ poetry install --extras "docs"

Testes

Para rodar os testes apenas com a versão atual do Python:

$ poetry run pytest

Para rodar com todas as versões de Python:

$ poetry run tox

Escrevendo testes de novos adaptadores

Quando criar m novo adaptador, escreva ao menos três casos de teste para o método adjust:

1. Utilizando apenas um argumento (data original)
2. Utilizando dois argumentos (data original mais valor personalizado)
3. Utilizando três argumentos (data original, valor personalizado e data final)

Documentação

Para a documentação, é preciso utilizar o Sphinx:

$ poetry run sphinx-build docs docs/_build

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

Limpeza de arquivos gerados automaticamente

Para limpar os arquivos gerados automaticamente, existe o atalho make clean.