# autohooks-plugin-mypy
[](https://github.com/greenbone/autohooks-plugin-mypy/releases)
[](https://pypi.org/project/autohooks-plugin-mypy/)
[](https://codecov.io/gh/greenbone/autohooks-plugin-mypy)
[](https://github.com/greenbone/autohooks-plugin-mypy/actions/workflows/ci-python.yml)
An [autohooks](https://github.com/greenbone/autohooks) plugin for python code
static typing check via [mypy](https://github.com/python/mypy).
## Installation
### Install using pip
You can install the latest stable release of autohooks-plugin-mypy from the
Python Package Index using [pip](https://pip.pypa.io/):
python3 -m pip install autohooks-plugin-mypy
### Install using poetry
It is highly encouraged to use [poetry](https://python-poetry.org) for
maintaining your project's dependencies. Normally autohooks-plugin-mypy is
installed as a development dependency.
poetry install
## Usage
To activate the mypy autohooks plugin please add the following setting to your
*pyproject.toml* file.
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.mypy"]
```
By default, autohooks plugin mypy checks all files with a *.py* ending. If
only files in a sub-directory or files with different endings should be
formatted, just add the following setting:
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.mypy"]
[tool.autohooks.plugins.mypy]
include = ['foo/*.py', '*.foo']
```
By default, autohooks plugin mypy executes mypy without any arguments.
To change specific settings or to define a mypy config file the following plugin configuration can be used:
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.mypy"]
[tool.autohooks.plugins.mypy]
arguments = ["--ignore-missing-imports", "--config-file=/path/to/.mypy.ini"]
```
## Maintainer
This project is maintained by [Greenbone AG](https://www.greenbone.net/).
## Contributing
Your contributions are highly appreciated. Please
[create a pull request](https://github.com/greenbone/autohooks-plugin-mypy/pulls)
on GitHub. Bigger changes need to be discussed with the development team via the
[issues section at GitHub](https://github.com/greenbone/autohooks-plugin-mypy/issues)
first.
## License
Copyright (C) 2021 [Vincent Texier](https://gitlab.com/VictorIndiaTango).
Copyright (C) 2023 [Greenbone AG](https://www.greenbone.net/)
Licensed under the [GNU General Public License v3.0 or later](LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/greenbone/autohooks-plugin-mypy",
"name": "autohooks-plugin-mypy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "git,static,typing,hooks,mypy",
"author": "Vincent Texier",
"author_email": "vit@free.fr",
"download_url": "https://files.pythonhosted.org/packages/02/3c/54d5fe6bc9a3f141b987b6ebab36ff89b5ac69eba178eee34049b2c2286c/autohooks_plugin_mypy-23.10.0.tar.gz",
"platform": null,
"description": "\n\n# autohooks-plugin-mypy\n\n[](https://github.com/greenbone/autohooks-plugin-mypy/releases)\n[](https://pypi.org/project/autohooks-plugin-mypy/)\n[](https://codecov.io/gh/greenbone/autohooks-plugin-mypy)\n[](https://github.com/greenbone/autohooks-plugin-mypy/actions/workflows/ci-python.yml)\n\nAn [autohooks](https://github.com/greenbone/autohooks) plugin for python code\nstatic typing check via [mypy](https://github.com/python/mypy).\n\n## Installation\n\n### Install using pip\n\nYou can install the latest stable release of autohooks-plugin-mypy from the\nPython Package Index using [pip](https://pip.pypa.io/):\n\n python3 -m pip install autohooks-plugin-mypy\n\n### Install using poetry\n\nIt is highly encouraged to use [poetry](https://python-poetry.org) for\nmaintaining your project's dependencies. Normally autohooks-plugin-mypy is\ninstalled as a development dependency.\n\n poetry install\n\n## Usage\n\nTo activate the mypy autohooks plugin please add the following setting to your\n*pyproject.toml* file.\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.mypy\"]\n```\n\nBy default, autohooks plugin mypy checks all files with a *.py* ending. If\nonly files in a sub-directory or files with different endings should be\nformatted, just add the following setting:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.mypy\"]\n\n[tool.autohooks.plugins.mypy]\ninclude = ['foo/*.py', '*.foo']\n```\n\nBy default, autohooks plugin mypy executes mypy without any arguments.\nTo change specific settings or to define a mypy config file the following plugin configuration can be used:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.mypy\"]\n\n[tool.autohooks.plugins.mypy]\narguments = [\"--ignore-missing-imports\", \"--config-file=/path/to/.mypy.ini\"]\n```\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/autohooks-plugin-mypy/pulls)\non GitHub. Bigger changes need to be discussed with the development team via the\n[issues section at GitHub](https://github.com/greenbone/autohooks-plugin-mypy/issues)\nfirst.\n\n## License\n\nCopyright (C) 2021 [Vincent Texier](https://gitlab.com/VictorIndiaTango).\nCopyright (C) 2023 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "An autohooks plugin for python code static typing check with mypy",
"version": "23.10.0",
"project_urls": {
"Homepage": "https://github.com/greenbone/autohooks-plugin-mypy",
"Repository": "https://github.com/greenbone/autohooks-plugin-mypy"
},
"split_keywords": [
"git",
"static",
"typing",
"hooks",
"mypy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9572eed8de6210a8a78cde7b18f4a10baad750f08a3c5e0c5651ec192e020764",
"md5": "046e02d409e2f4ac8a4532d5743f9945",
"sha256": "8ac36b74900b2f2456fec046126e564374acd6de2752d87255c6f71c4e6a73ff"
},
"downloads": -1,
"filename": "autohooks_plugin_mypy-23.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "046e02d409e2f4ac8a4532d5743f9945",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 17117,
"upload_time": "2023-10-18T11:18:56",
"upload_time_iso_8601": "2023-10-18T11:18:56.819891Z",
"url": "https://files.pythonhosted.org/packages/95/72/eed8de6210a8a78cde7b18f4a10baad750f08a3c5e0c5651ec192e020764/autohooks_plugin_mypy-23.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "023c54d5fe6bc9a3f141b987b6ebab36ff89b5ac69eba178eee34049b2c2286c",
"md5": "ec0377ff4edba0fec559e98246c26f81",
"sha256": "ebefaa83074b662de38c914f6cac9f4f8e3452e36f54a5834df3f1590cc0c540"
},
"downloads": -1,
"filename": "autohooks_plugin_mypy-23.10.0.tar.gz",
"has_sig": false,
"md5_digest": "ec0377ff4edba0fec559e98246c26f81",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 16730,
"upload_time": "2023-10-18T11:18:58",
"upload_time_iso_8601": "2023-10-18T11:18:58.119171Z",
"url": "https://files.pythonhosted.org/packages/02/3c/54d5fe6bc9a3f141b987b6ebab36ff89b5ac69eba178eee34049b2c2286c/autohooks_plugin_mypy-23.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-18 11:18:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greenbone",
"github_project": "autohooks-plugin-mypy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "autohooks-plugin-mypy"
}
JSON
