Instalação

O idecomp é compatível com versões de Python >= 3.5. A única dependência formal é o módulo NumPy, que deve sempre ser mantido na versão mais atualizada para a distribuição de Python instalada.

Em posse de uma instalação local de Python, é recomendado que se use um ambiente virtual para instalação de módulos de terceiros, sendo que o idecomp não é uma exceção. Para mais detalhes sobre o uso de ambientes virtuais, recomenda-se a leitura do recurso oficial de Python para ambientes virtuais: venv.

Antes de prosseguir, é necessário verificar se está instalada a última versão do pip, o gerenciador de pacotes de Python. Isso pode ser feito com, por exemplo:

$ python -m pip install ---upgrade pip

Para maiores informações, é recomendado visitar a documentação oficial do pip.

Instalando a versão distribuída oficialmente

É possível instalar a versão distribuída oficialmente com pip:

$ pip install idecomp

Para atualizar para uma versão mais recente, basta adicionar a flag --upgrade:

$ pip install --upgrade idecomp

Para instalar uma versão específica:

$ pip install --upgrade idecomp==x.y.z

É possível instalar também a partir do código fonte. Basta acessar a página de releases, baixar o arquivo comprimido com o código do módulo e executar no diretório:

$ pip install .

Instalando a versão de desenvolvimento

É possível realizar a instalação desta versão fazendo o uso do Git. Para instalar a versão de desenvolvimento, é necessário primeiramente desinstalar a versão instalada (se houve), com:

$ pip uninstall idecomp

Em seguida, basta fazer:

$ git clone https://github.com/rjmalves/idecomp
$ cd idecomp
$ pip install -e

Procedimentos de teste

O idecomp realiza testes utilizando o pacote de testes de Python pytest. Para maiores informações, é recomendado acessar a página.

Além dos testes, o código também tem sua qualidade aferida com o uso de flake8 e mypy.