https://github.com/pylint-dev/pylint-plugin-utils

Utilities and helpers for writing Pylint plugins
https://github.com/pylint-dev/pylint-plugin-utils

Last synced: 1 day ago
JSON representation

Utilities and helpers for writing Pylint plugins

• Host: GitHub
• URL: https://github.com/pylint-dev/pylint-plugin-utils
• Owner: pylint-dev
• License: gpl-2.0
• Created: 2013-10-05T06:47:06.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2025-03-31T20:22:38.000Z (3 months ago)
• Last Synced: 2025-06-22T00:12:39.200Z (3 days ago)
• Language: Python
• Size: 138 KB
• Stars: 24
• Watchers: 3
• Forks: 12
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pylint-plugin-utils

## Status

[![Build Status](https://github.com/PyCQA/pylint-plugin-utils/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/PyCQA/pylint-plugin-utils/actions)

[![Coverage Status](https://coveralls.io/repos/github/PyCQA/pylint-plugin-utils/badge.svg?branch=master)](https://coveralls.io/github/PyCQA/pylint-plugin-utils?branch=master)

[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

[![Pypi Package version](https://img.shields.io/pypi/v/pylint-plugin-utils.svg)](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.