semvec/pypi-packages huggingface dataset:
lintel 0.1.0
Python docstring style checker
License: MIT
Requires Python: >=3.8
Keywords: lintel,pydocstyle,PEP 257,pep257,PEP 8,pep8,docstrings

lintel - docstring style checker
====================================


.. image:: https://github.com/Mr-Pepe/lintel/actions/workflows/pipeline.yml/badge.svg?branch=main
    :target: https://github.com/Mr-Pepe/lintel/actions?query=workflow%3A%22CI+Pipeline%22+branch%3Amain

.. image:: https://codecov.io/github/Mr-Pepe/lintel/branch/main/graph/badge.svg?token=WVIRUBOOEC
    :target: https://codecov.io/github/Mr-Pepe/lintel

.. image:: https://readthedocs.org/projects/lintel/badge/?version=latest
    :target: https://lintel.readthedocs.io/en/latest/

.. image:: https://pepy.tech/badge/lintel
    :target: https://pepy.tech/project/lintel

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat
    :target: https://pycqa.github.io/isort/

.. image:: http://www.mypy-lang.org/static/mypy_badge.svg
    :target: http://mypy-lang.org/

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT


**Lintel** is a static analysis tool for checking compliance with Python
docstring conventions.

It started as a fork of `pydocstyle <https://github.com/PyCQA/pydocstyle>`_ with the goal to
eventually also cover the functionality provided by `pylint's <https://github.com/PyCQA/pylint>`_
`docparams extension <https://pylint.pycqa.org/en/latest/user_guide/checkers/extensions.html#pylint-extensions-docparams>`_.

Install Lintel with::

    pip install lintel

Find out how to use it by executing::

    lintel --help

Get more information in the `official documentation <https://lintel.readthedocs.io/en/latest/>`_.