Welcome To Docsweeper’s Documentation!#
Docsweeper is a linter for version controlled Python code bases that finds potentially outdated docstrings in your source files. For every code token in the file that has a docstring (see PEP 257), Docsweeper will interact with your Git or Mercurial version control system to determine:
in which revision the docstring has last been changed, and
how often the source code that is referenced by the docstring has been altered since that revision.
Used as a stand-alone application or as a plugin for the Flake8 linter, Docsweeper can be integrated into your code check-in or linting process easily and help you quickly determine which docstrings potentially contain obsolete information.
Compatibility#
Docsweeper supports Linux, Mac, and Windows platforms that are compatible with Python 3.7 or newer. In addition to a working Python installation, you will also need at least one of the version control systems you intend to use Docsweeper with:
Git v1.7.0 or newer, and/or
Mercurial v5.2 or newer. This is the the first release of Mercurial with official support for Python 3.
Installation#
In addition to a working Python v3.7+ environment, the following additional packages are required as well:
click v8.1.0 or newer.
Docsweeper is available on PyPI. Install it with pip to take care of dependencies automatically:
$ pip install docsweeper
After installation, see section Usage for instructions on how to configure and run Docsweeper on your code base.