# pylint-plugin-utils
## Status
[](https://github.com/PyCQA/pylint-plugin-utils/actions)
[](https://coveralls.io/github/PyCQA/pylint-plugin-utils?branch=master)
[](https://github.com/ambv/black)
[](https://pypi.python.org/pypi/pylint-plugin-utils)
# About
Utilities and helpers for writing Pylint plugins. This is not a direct Pylint plugin, but rather a set of tools and functions used by other plugins such as [pylint-django](https://github.com/PyCQA/pylint-django) and [pylint-celery](https://github.com/PyCQA/pylint-celery).
# Testing
Create virtualenv:
```bash
python3.8 -m venv .pylint-plugin-utils
source .pylint-plugin-utils/bin/activate
pip install --upgrade pip setuptools
```
We use [tox](https://tox.readthedocs.io/en/latest/) for running the test suite. You should be able to install it with:
```bash
pip install tox pytest
```
To run the test suite for a particular Python version, you can do:
```bash
tox -e py38
```
To run individual tests with ``tox``, you can do:
```bash
tox -e py38 -- -k test_linter_should_be_pickleable
```
We use ``pytest`` for testing ``pylint``, which you can use without using ``tox`` for a faster development cycle.
If you want to run tests on a specific portion of the code with [pytest](https://docs.pytest.org/en/latest/), [pytest-cov](https://pypi.org/project/pytest-cov/) and your local python version::
```bash
pip install pytest-cov
# Everything:
python3 -m pytest tests/ --cov=pylint_plugin_utils
coverage html
```
# License
`pylint-plugin-utils` is available under the GPLv2 License.
Raw data
{
"_id": null,
"home_page": "https://github.com/PyCQA/pylint-plugin-utils",
"name": "pylint-plugin-utils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "pylint,plugin,helpers",
"author": "Carl Crowder",
"author_email": "git@carlcrowder.com",
"download_url": "https://files.pythonhosted.org/packages/4b/d2/3b9728910bc69232ec38d8fb7053c03c887bfe7e6e170649b683dd351750/pylint_plugin_utils-0.8.2.tar.gz",
"platform": null,
"description": "# pylint-plugin-utils\n\n## Status\n\n[](https://github.com/PyCQA/pylint-plugin-utils/actions)\n[](https://coveralls.io/github/PyCQA/pylint-plugin-utils?branch=master)\n[](https://github.com/ambv/black)\n[](https://pypi.python.org/pypi/pylint-plugin-utils)\n\n# About\n\nUtilities and helpers for writing Pylint plugins. This is not a direct Pylint plugin, but rather a set of tools and functions used by other plugins such as [pylint-django](https://github.com/PyCQA/pylint-django) and [pylint-celery](https://github.com/PyCQA/pylint-celery).\n\n# Testing\nCreate virtualenv:\n```bash\npython3.8 -m venv .pylint-plugin-utils\nsource .pylint-plugin-utils/bin/activate\npip install --upgrade pip setuptools\n```\n\nWe use [tox](https://tox.readthedocs.io/en/latest/) for running the test suite. You should be able to install it with:\n```bash\npip install tox pytest\n```\n\nTo run the test suite for a particular Python version, you can do:\n```bash\ntox -e py38\n```\n\nTo run individual tests with ``tox``, you can do:\n```bash\ntox -e py38 -- -k test_linter_should_be_pickleable\n```\n\nWe use ``pytest`` for testing ``pylint``, which you can use without using ``tox`` for a faster development cycle.\n\nIf you want to run tests on a specific portion of the code with [pytest](https://docs.pytest.org/en/latest/), [pytest-cov](https://pypi.org/project/pytest-cov/) and your local python version::\n```bash\npip install pytest-cov\n# Everything:\npython3 -m pytest tests/ --cov=pylint_plugin_utils\ncoverage html\n```\n\n# License\n\n`pylint-plugin-utils` is available under the GPLv2 License.\n\n",
"bugtrack_url": null,
"license": "GPL-2.0-or-later",
"summary": "Utilities and helpers for writing Pylint plugins",
"version": "0.8.2",
"project_urls": {
"Homepage": "https://github.com/PyCQA/pylint-plugin-utils",
"Repository": "https://github.com/PyCQA/pylint-plugin-utils"
},
"split_keywords": [
"pylint",
"plugin",
"helpers"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "afee49d11aee31061bcc1d2726bd8334a2883ddcdbde7d7744ed6b3bd11704ed",
"md5": "89ed02391b2a794a9bae4399c7e57b6c",
"sha256": "ae11664737aa2effbf26f973a9e0b6779ab7106ec0adc5fe104b0907ca04e507"
},
"downloads": -1,
"filename": "pylint_plugin_utils-0.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "89ed02391b2a794a9bae4399c7e57b6c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 11171,
"upload_time": "2023-05-20T04:42:13",
"upload_time_iso_8601": "2023-05-20T04:42:13.650051Z",
"url": "https://files.pythonhosted.org/packages/af/ee/49d11aee31061bcc1d2726bd8334a2883ddcdbde7d7744ed6b3bd11704ed/pylint_plugin_utils-0.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4bd23b9728910bc69232ec38d8fb7053c03c887bfe7e6e170649b683dd351750",
"md5": "515490483136c33524b14f08a1c6a2d1",
"sha256": "d3cebf68a38ba3fba23a873809155562571386d4c1b03e5b4c4cc26c3eee93e4"
},
"downloads": -1,
"filename": "pylint_plugin_utils-0.8.2.tar.gz",
"has_sig": false,
"md5_digest": "515490483136c33524b14f08a1c6a2d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 10674,
"upload_time": "2023-05-20T04:42:16",
"upload_time_iso_8601": "2023-05-20T04:42:16.154916Z",
"url": "https://files.pythonhosted.org/packages/4b/d2/3b9728910bc69232ec38d8fb7053c03c887bfe7e6e170649b683dd351750/pylint_plugin_utils-0.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-20 04:42:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PyCQA",
"github_project": "pylint-plugin-utils",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "pylint-plugin-utils"
}
JSON
