File: README.rst

package info (click to toggle)
pytest-pylint 0.6.0-1~bpo8+1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-backports
  • size: 136 kB
  • sloc: python: 189; makefile: 9
file content (44 lines) | stat: -rw-r--r-- 1,393 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
pytest pylint
-------------
.. image:: https://img.shields.io/travis/carsongee/pytest-pylint.svg
    :target: https://travis-ci.org/carsongee/orcoursetrion
.. image:: https://img.shields.io/coveralls/carsongee/pytest-pylint.svg
    :target: https://coveralls.io/r/carsongee/pytest-pylint
.. image:: https://img.shields.io/pypi/v/pytest-pylint.svg
    :target: https://pypi.python.org/pypi/pytest-pylint
.. image:: https://img.shields.io/pypi/dm/pytest-pylint.svg
    :target: https://pypi.python.org/pypi/pytest-pylint
.. image:: https://img.shields.io/pypi/l/pytest-pylint.svg
    :target: https://pypi.python.org/pypi/pytest-pylint

Run pylint with pytest and have configurable rule types
(i.e. Convention, Warn, and Error) fail the build.  You can also
specify a pylintrc file.

Sample Usage
============
.. code-block:: shell

   py.test --pylint

would be the most simple usage and would run pylint for all error messages.

.. code-block:: shell

   py.test --pylint --pylint-rcfile=/my/pyrc --pylint-error-types=EF

This would use the pylintrc file at /my/pyrc and only error on pylint
Errors and Failures.

You can restrict your test run to only perform pylint checks and not any other
tests by typing:

.. code-block:: shell

    py.test --pylint -m pylint

Acknowledgements
================

This code is heavily based on 
`pytest-flakes <https://github.com/fschulze/pytest-flakes>`_