Metadata-Version: 2.1
Name: importchecker
Version: 2.0
Summary: Importchecker finds unused imports in Python modules.
Home-page: http://pypi.python.org/pypi/importchecker
Author: Jan-Wijbrand Kolman
Author-email: janwijbrand@gmail.com
License: ZPL 2.1
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Zope Public License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
License-File: LICENSE.rst
Requires-Dist: setuptools
Provides-Extra: test
Requires-Dist: zope.testrunner ; extra == 'test'

Importchecker
=============

What is importchecker?
----------------------

Importchecker is a commandline utility to find unused imports in Python
modules.

Its output is "grep-like" (and thus "emacs-friendly"), reporting both the
module's filenames and line numbers where names are imported that are not
acually used in the module.

Importchecker will not modify any of the source files. Whether the import
needs to be removed is left to the judgement of the developer.

Installation
------------

The importchecker commandline utility can be installed using the
``easy_install`` command::

  $ sudo easy_install importchecker

The command can then be invoked with either a directory or a Python file::

  $ importchecker /path/to/a/source/tree
  $ importchecker /path/to/a/source/tree/module.py

Buildout
--------

Projects that make use of `zc.buildout`_ for development might find the
following ``buildout.cfg.`` snippet useful for using the importchecker on
the developed codebase::

  [buildout]
  ...
  parts = importchecker ...
  ...

  [importchecker]
  recipe = zc.recipe.egg
  eggs = importchecker
  arguments = "${buildout:directory}/src"

.. _`zc.buildout`: http://pypi.python.org/pypi/zc.buildout

Known issues
------------

* Official Python 2 support was dropped. Informal tests indicate
  `importchecker` still works for Python 2, but since the AST structures
  can differ between Python 2 and Python 3, no support is formally claimed.

* One source tree path argument at the time can be passed to the command
  line utility.

* Command line argument parsing is rather naïve.

Changes
=======

2.0 (2018-02-22)
----------------

* The tests indicate `importchecker` still works for Python 2, but since
  the AST structures can differ between Python 2 and Python 3, no support is
  formally claimed.

1.2 (2018-02-21)
----------------

* Start on test coverage.

* Claim support for Python 2.7, drop claims for earlier versions.

1.1 (2012-01-09)
----------------

* Applied provided by wosc enabling running the import checker on
  individual python modules not just directories.

* Report the absolute path for modules when needed, relative paths (relative
  to the current working directory, that is) when possible.

1.0 (2008-05-06)
----------------

* Initial packaging

* Make the importchecker work on python 2.5

Credits
=======

* Martijn Faassen (original developer)
* Jan-Wijbrand Kolman (packaging)
* Philipp von Weitershausen
* various comitters on svn.zope.org.

Download
========


