Metadata-Version: 2.1
Name: docsweeper
Version: 1.2.1
Summary: A linter for your Python code base that finds potentially outdated docstrings using version control.
Home-page: https://docsweeper.readthedocs.io/
License: MIT
Author: Andreas Thüring
Author-email: a.thuering@gmail.com
Requires-Python: >=3.7,<3.11
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Plugins
Classifier: Framework :: Flake8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.8 
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: Software Development :: Version Control :: Mercurial
Classifier: Topic :: Utilities
Requires-Dist: click (>=8.1.0,<9.0.0)
Project-URL: Documentation, https://docsweeper.readthedocs.io/
Project-URL: Repository, https://github.com/thueringa/docsweeper
Description-Content-Type: text/x-rst

============
 Docsweeper
============

.. image:: https://img.shields.io/pypi/pyversions/docsweeper?style=flat-square
   :alt: PyPI - Python Version
   :target: https://pypi.org/project/docsweeper/

.. image:: https://img.shields.io/pypi/v/docsweeper?style=flat-square
   :alt: PyPI
   :target: https://pypi.org/project/docsweeper/

.. image:: https://readthedocs.org/projects/docsweeper/badge/?version=stable
   :target: https://docsweeper.readthedocs.io/en/stable/?badge=stable
   :alt: Documentation Status

.. image:: https://img.shields.io/pypi/l/docsweeper?style=flat-square
   :alt: PyPI - License
   :target: https://pypi.org/project/docsweeper/

*Docsweeper* is a linter for version controlled *Python* code bases that finds
potentially outdated docstrings. *Docsweeper* interacts with the version control system
to retrieve a full revision history of a given *Python* source file. For every code
token in the file that has a docstring (see `PEP 257
<https://peps.python.org/pep-0257/>`_), *Docsweeper* will analyze the version control
history 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.

This can help you quickly find potentially outdated docstrings in your *Python* code
base.

*Docsweeper* can be used as a stand-alone application or as a plugin for the `Flake8
<https://flake8.pycqa.org/en/latest/>`_ linter.

*Docsweeper* supports the following version control systems:

- `Git <https://git-scm.com/>`_ v1.7.0 or newer, and
- `Mercurial <https://www.mercurial-scm.org/>`_ v5.2 or newer.

Refer to the `documentation <https://docsweeper.readthedocs.io/>`_ for more information.

