Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greenbone/autohooks-plugin-pytest
https://github.com/greenbone/autohooks-plugin-pytest
automation devops extended hooks python
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/greenbone/autohooks-plugin-pytest
- Owner: greenbone
- License: gpl-3.0
- Created: 2022-01-27T11:41:55.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T06:13:22.000Z (7 months ago)
- Last Synced: 2024-04-17T16:11:16.462Z (7 months ago)
- Topics: automation, devops, extended, hooks, python
- Language: Python
- Homepage:
- Size: 534 KB
- Stars: 2
- Watchers: 9
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- jimsghstars - greenbone/autohooks-plugin-pytest - (Python)
README
# 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).