Metadata-Version: 2.1
Name: numpydoc-linter
Version: 0.2.0
Summary: Numpydoclint is a linter for Numpy style docstrings.
Home-page: https://github.com/nickuzmenkov/numpydoclint
License: MIT
Keywords: docstring,linting,documentation,code quality,python,static analysis,pep257,pep8,style guide,coding standards,syntax check,code checker
Author: Nick Kuzmenkov
Author-email: nickuzmenkov@yahoo.com
Maintainer: Nick Kuzmenkov
Maintainer-email: nickuzmenkov@yahoo.com
Requires-Python: >=3.9.0,<4.0.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Dist: click (>=8.0,<9.0)
Requires-Dist: numpydoc (>=1.5.0,<2.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Project-URL: Documentation, https://nickuzmenkov.github.io/numpydoclint/
Project-URL: Repository, https://github.com/nickuzmenkov/numpydoclint
Description-Content-Type: text/markdown

# Numpydoclint

Numpydoclint is a linter for [Numpy style][numpy-style] docstrings.

```
$ numpydoclint -vv asgard midgard/thor.py
asgard/loki.py:12 in function loki.mischief:
    GL03 Double line break found
asgard/odin.py:10 in type asgard.odin.Allfather:
    SA04 Missing description for See Also 'Yggdrasil' reference
midgard/thor.py:20 in function thor.Thor.strike:
    PR01 Parameters {'mjolnir'} not documented
Errors found in 3 out of 9 objects checked.
```

Numpydoclint uses static file analysis to identify code objects and then uses the [`numpydoc.validate`][numpydoc-validate] module for validation, outputting corresponding [error codes][error-codes] along with explanatory comments.

## Installation

You can install Numpydoclint via the [PIP][pip] package manager:

```bash
$ pip install numpydoc-linter
```

Alternatively, if you wish to install from the source code, follow these steps. Clone the repository and use [Poetry][poetry] to manage the project dependencies specified in `pyproject.toml`:

```bash
$ git clone https://github.com/nickuzmenkov/numpydoclint.git
$ cd numpydoclint
$ poetry install
```

## Usage

Basic usage examples, as well as more advanced usage scenarios are covered in detail in the [Official Documentation][docs].

[numpy-style]: https://numpydoc.readthedocs.io/en/latest/format.html
[numpydoc-validate]: https://numpydoc.readthedocs.io/en/latest/validation.html
[error-codes]: https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks
[pip]: https://pip.pypa.io/en/stable/
[poetry]: https://python-poetry.org/
[docs]: https://nickuzmenkov.github.io/numpydoclint/
