# autohooks-plugin-pytest
[](https://pypi.org/project/autohooks-plugin-pytest/)
An [autohooks](https://github.com/greenbone/autohooks) plugin for [pytest](https://github.com/pytest-dev/pytest/).
## Installation
### Install using pip
You can install the latest stable release of autohooks-plugin-pytest from the
Python Package Index using [pip](https://pip.pypa.io/):
python3 -m pip install autohooks-plugin-pytest
### Install using poetry
It is highly encouraged to use [poetry](https://python-poetry.org) for
maintaining your project's dependencies. Normally autohooks-plugin-pytest is
installed as a development dependency.
poetry install
## Usage
To activate the pytest autohooks plugin please add the following setting to your
*pyproject.toml* file.
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.pytest"]
```
By default, autohooks plugin pytest checks all files with a *.py* ending. If
only files in a sub-directory or files with different endings should be
tested, just add the following setting:
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.pytest"]
[tool.autohooks.plugins.pytest]
include = ['foo/*.py', '*.foo']
```
By default, autohooks plugin pytest executes pytest without any arguments and
pytest settings are loaded from the *.pytestrc* file in the root directory of
git repository. To change specific settings or to define a different pytest rc
file the following plugin configuration can be used:
```toml
[tool.autohooks]
pre-commit = ["autohooks.plugins.pytest"]
[tool.autohooks.plugins.pytest]
arguments = ["--rcfile=/path/to/pytestrc", "-s", "n"]
```
## 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-pytest/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-pytest/issues)
first.
## License
Copyright (C) 2021-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-pytest",
"name": "autohooks-plugin-pytest",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "git,formatting,linting,hooks,pytest",
"author": "Greenbone AG",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/56/6f/76342f15644c27e8164bd736361dd5995d2d337532a1a03777b9c92fe641/autohooks_plugin_pytest-23.10.0.tar.gz",
"platform": null,
"description": "\n\n# autohooks-plugin-pytest\n\n[](https://pypi.org/project/autohooks-plugin-pytest/)\n\nAn [autohooks](https://github.com/greenbone/autohooks) plugin for [pytest](https://github.com/pytest-dev/pytest/).\n\n## Installation\n\n### Install using pip\n\nYou can install the latest stable release of autohooks-plugin-pytest from the\nPython Package Index using [pip](https://pip.pypa.io/):\n\n python3 -m pip install autohooks-plugin-pytest\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-pytest is\ninstalled as a development dependency.\n\n poetry install\n\n## Usage\n\nTo activate the pytest autohooks plugin please add the following setting to your\n*pyproject.toml* file.\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.pytest\"]\n```\n\nBy default, autohooks plugin pytest checks all files with a *.py* ending. If\nonly files in a sub-directory or files with different endings should be\ntested, just add the following setting:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.pytest\"]\n\n[tool.autohooks.plugins.pytest]\ninclude = ['foo/*.py', '*.foo']\n```\n\nBy default, autohooks plugin pytest executes pytest without any arguments and\npytest settings are loaded from the *.pytestrc* file in the root directory of\ngit repository. To change specific settings or to define a different pytest rc\nfile the following plugin configuration can be used:\n\n```toml\n[tool.autohooks]\npre-commit = [\"autohooks.plugins.pytest\"]\n\n[tool.autohooks.plugins.pytest]\narguments = [\"--rcfile=/path/to/pytestrc\", \"-s\", \"n\"]\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-pytest/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-pytest/issues)\nfirst.\n\n## License\n\nCopyright (C) 2021-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 pytest",
"version": "23.10.0",
"project_urls": {
"Homepage": "https://github.com/greenbone/autohooks-plugin-pytest",
"Repository": "https://github.com/greenbone/autohooks-plugin-pytest"
},
"split_keywords": [
"git",
"formatting",
"linting",
"hooks",
"pytest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "18352041cdf31e40e921d28e9ffaad2a04fe455622e367fd61522b65cfa1299d",
"md5": "10fada1e17c45ad0cb4e49e95d8a9543",
"sha256": "581a92e09cf7882f5488973290d29f35684bec984537832f26c8a7e7c245eedb"
},
"downloads": -1,
"filename": "autohooks_plugin_pytest-23.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "10fada1e17c45ad0cb4e49e95d8a9543",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 16929,
"upload_time": "2023-10-18T12:14:22",
"upload_time_iso_8601": "2023-10-18T12:14:22.509711Z",
"url": "https://files.pythonhosted.org/packages/18/35/2041cdf31e40e921d28e9ffaad2a04fe455622e367fd61522b65cfa1299d/autohooks_plugin_pytest-23.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "566f76342f15644c27e8164bd736361dd5995d2d337532a1a03777b9c92fe641",
"md5": "6962c0730ba1b50f5437b23877f23174",
"sha256": "87125b8291e0e04da2d24255581622b957f090f2c96cf50a4396fb455a3c8864"
},
"downloads": -1,
"filename": "autohooks_plugin_pytest-23.10.0.tar.gz",
"has_sig": false,
"md5_digest": "6962c0730ba1b50f5437b23877f23174",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 15471,
"upload_time": "2023-10-18T12:14:24",
"upload_time_iso_8601": "2023-10-18T12:14:24.106114Z",
"url": "https://files.pythonhosted.org/packages/56/6f/76342f15644c27e8164bd736361dd5995d2d337532a1a03777b9c92fe641/autohooks_plugin_pytest-23.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-18 12:14:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greenbone",
"github_project": "autohooks-plugin-pytest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "autohooks-plugin-pytest"
}
JSON
