Tool for Brazilian Reais monetary adjustment/correction
Project description
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(date(2014, 7, 8), 7)
Out[4]: Decimal('9.407523138792336916983267321')
In [5]: ipca.adjust(date(1998, 7, 12), 3, date(2006, 7, 1))
Out[5]: Decimal('5.279855889296777979447848574')
Mini-guia de contribuição
Testes
A suíte de testes roda com diversas versões do Python via tox
. Se você não tiver instalado, pip install tox
deve resolver.
$ tox
Se quiser rodar os testes mais rapidamente apenas para a versão em uso, é possível utilizar o pytest
, mas é necessário instalar alguns pacotes extras:
$ pip install pytest pytest-black pytest-cov pytest-mock pytest-mypy
Escrevendo testes de novos adaptadores
Quando criar m novo adaptador, escreva ao menos três casos de teste para o método adjust
:
- Utilizando apenas um argumento (data original)
- Utilizando dois argumentos (data original mais valor personalizado)
- Utilizando três argumentos (data original, valor personalizado e data final)
Documentação
Para visualizar alterações na documentação, é preciso instalar alguns pacotes e utilizar a o Sphinx:
$ pip install -e .
$ pip install -r docs/requirements.txt
$ 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
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for calculadora-do-cidadao-0.4.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dda377dd09bdb8cbe95a80e36c9ae07f5ef35ba4601fb4c049669e3f5edd26e4 |
|
MD5 | 6adf5bd034e59ff2507204ccd11b7b33 |
|
BLAKE2b-256 | a7e5098b2e98763d47a0df76e209552769b57ac545c823fc8d240a183b952ea5 |