important 0.1.3

Installation

Install the latest stable version from PyPI using:

pip install important

Otherwise, to grab the latest version on master, use:

pip install git+https://github.com/cfournie/important.git

Requirements

This works best when run from a virtualenv where your project’s requirements are installed (to translate requirements to module names).

This tool requires that it be installed with the same Python version as the source code that it’s analyzing and that the source code is syntactically correct.

Usage

Check for unused requirements using:

$ important -v --requirements requirements.txt .
Parsed 52 imports in 8 files
Error: Unused requirements or violated constraints found
caniusepython3 (unused requirement)

Check for imports that are used too frequently (to prevent further usage of a requirement while you phase it out) using:

$ important -v --constraints constraints.txt .
Parsed 52 imports in 8 files
Error: Unused requirements or violated constraints found
click<=1 (constraint violated by click==2)

Check for unused requirements but exclude test files using:

$ important -v --requirements requirements.txt --exclude **/test_*.py .
Parsed 52 imports in 8 files
Error: Unused requirements or violated constraints found
caniusepython3 (unused requirement)

Ignore errors related to some of your requirements using:

$ important -v --requirements requirements.txt --ignore caniusepython3 .
Parsed 52 imports in 8 files
$ important -v --requirements requirements.txt --ignorefile ignored.txt .
Parsed 52 imports in 8 files

Alternatively, you can configure important using a setup.cfg file in the current working directory, e.g.:

[important]
requirements=
    requirements.txt
constraints=
    constraints.txt
ignore=
    Sphinx
    flake8
exclude=
    .git
sourcecode=.

Then run using:

$ important -v
Parsed 52 imports in 8 files