# Numpydoclint
Numpydoclint is a linter for [Numpy style][numpy-style] docstrings.
```
$ numpydoclint -vv asgard midgard/thor.py
asgard/loki.py:12 in function asgard.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/
Raw data
{
"_id": null,
"home_page": "https://github.com/nickuzmenkov/numpydoclint",
"name": "numpydoc-linter",
"maintainer": "Nick Kuzmenkov",
"docs_url": null,
"requires_python": ">=3.9.0,<4.0.0",
"maintainer_email": "nickuzmenkov@yahoo.com",
"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",
"download_url": "https://files.pythonhosted.org/packages/06/2e/10c1a04406d25d22d10ca1d6dec7b34ab8ef88f6f9687aeb7629f32215d2/numpydoc_linter-0.3.0.tar.gz",
"platform": null,
"description": "# Numpydoclint\n\nNumpydoclint is a linter for [Numpy style][numpy-style] docstrings.\n\n```\n$ numpydoclint -vv asgard midgard/thor.py\nasgard/loki.py:12 in function asgard.loki.mischief:\n GL03 Double line break found\nasgard/odin.py:10 in type asgard.odin.Allfather:\n SA04 Missing description for See Also 'Yggdrasil' reference\nmidgard/thor.py:20 in function thor.Thor.strike:\n PR01 Parameters {'mjolnir'} not documented\nErrors found in 3 out of 9 objects checked.\n```\n\nNumpydoclint 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.\n\n## Installation\n\nYou can install Numpydoclint via the [PIP][pip] package manager:\n\n```bash\n$ pip install numpydoc-linter\n```\n\nAlternatively, 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`:\n\n```bash\n$ git clone https://github.com/nickuzmenkov/numpydoclint.git\n$ cd numpydoclint\n$ poetry install\n```\n\n## Usage\n\nBasic usage examples, as well as more advanced usage scenarios are covered in detail in the [Official Documentation][docs].\n\n[numpy-style]: https://numpydoc.readthedocs.io/en/latest/format.html\n[numpydoc-validate]: https://numpydoc.readthedocs.io/en/latest/validation.html\n[error-codes]: https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks\n[pip]: https://pip.pypa.io/en/stable/\n[poetry]: https://python-poetry.org/\n[docs]: https://nickuzmenkov.github.io/numpydoclint/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Numpydoclint is a linter for Numpy style docstrings.",
"version": "0.3.0",
"project_urls": {
"Documentation": "https://nickuzmenkov.github.io/numpydoclint/",
"Homepage": "https://github.com/nickuzmenkov/numpydoclint",
"Repository": "https://github.com/nickuzmenkov/numpydoclint"
},
"split_keywords": [
"docstring",
"linting",
"documentation",
"code quality",
"python",
"static analysis",
"pep257",
"pep8",
"style guide",
"coding standards",
"syntax check",
"code checker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1e666047e490940c6379bf08ce6fe4c1792874ce55599b2efbe80dc59b94e13",
"md5": "0474463b3a0a7b102116fb595de0d9d9",
"sha256": "245f7ee551c01206d011bfb6750aaade5f18496f107fd5cc6c963de604f79097"
},
"downloads": -1,
"filename": "numpydoc_linter-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0474463b3a0a7b102116fb595de0d9d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0,<4.0.0",
"size": 17838,
"upload_time": "2023-08-27T19:44:57",
"upload_time_iso_8601": "2023-08-27T19:44:57.273055Z",
"url": "https://files.pythonhosted.org/packages/f1/e6/66047e490940c6379bf08ce6fe4c1792874ce55599b2efbe80dc59b94e13/numpydoc_linter-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "062e10c1a04406d25d22d10ca1d6dec7b34ab8ef88f6f9687aeb7629f32215d2",
"md5": "b68a8cc9c43fc3ee2ded28e7cecf26fa",
"sha256": "304e10e3f3634d5e88645dff8dcccd9c9d074a8e473775c84f0032fd3e6e60ad"
},
"downloads": -1,
"filename": "numpydoc_linter-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "b68a8cc9c43fc3ee2ded28e7cecf26fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0,<4.0.0",
"size": 13493,
"upload_time": "2023-08-27T19:44:58",
"upload_time_iso_8601": "2023-08-27T19:44:58.825601Z",
"url": "https://files.pythonhosted.org/packages/06/2e/10c1a04406d25d22d10ca1d6dec7b34ab8ef88f6f9687aeb7629f32215d2/numpydoc_linter-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-27 19:44:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nickuzmenkov",
"github_project": "numpydoclint",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "numpydoc-linter"
}
JSON
