Skip to main content

pylama -- Code audit tool for python

Project description

|logo| Pylama

.. _description:

Code audit tool for Python and JavaScript. Pylama wraps these tools:

* PEP8_ © 2012-2013, Florent Xicluna;
* PEP257_ © 2012, GreenSteam, <>
* PyFlakes_ © 2005-2013, Kevin Watters;
* Mccabe_ © Ned Batchelder;
* Pylint_ © 2013, Logilab (should be installed 'pylama_pylint' module);
* gjslint_ © The Closure Linter Authors (should be installed 'pylama_gjslint' module);

| `Pylint doesnt supported in python3.`

.. _badges:

.. image::
:alt: Build Status

.. image::
:alt: Coverals

.. image::
:alt: Version

.. image::
:alt: Downloads

.. image::
:alt: Donate

.. _documentation:

Docs are available at Pull requests with documentation enhancements and/or fixes are awesome and most welcome.

.. _contents:

.. contents::

.. _requirements:


- Python (2.6, 2.7, 3.2, 3.3)
- To use JavaScript checker (``gjslint``) you need to install ``python-gflags`` with ``pip install python-gflags``.
- If your tests are failing on Win platform you are missing: ``curses`` -
(The curses library supplies a terminal-independent screen-painting and keyboard-handling facility for text-based terminals)

.. _installation:

**Pylama** should be installed using pip: ::

$ pip install pylama

.. _quickstart:


**Pylama** is easy to use and realy fun for checking code quality.
Just run `pylama` and get common output from all pylama plugins (PEP8_, PyFlakes_ and etc)

Recursive check the current directory. ::

$ pylama

Recursive check a path. ::

$ pylama <path_to_directory_or_file>

Ignore some errors ::

$ pylama -i W,E501

Customize linters ::

$ pylama -l "pep8,mccabe"

Customize linters for JavaScript::

$ pylama --linters=gjslint --ignore=E:0010 <path_to_directory_or_file>

.. _options:

Command line options

$ pylama --help

usage: [-h] [--verbose] [--format {pep8,pylint}] [--select SELECT]
[--linters LINTERS] [--ignore IGNORE] [--skip SKIP]
[--complexity COMPLEXITY] [--report REPORT] [--hook]
[--options OPTIONS]

Code audit tool for python.

positional arguments:
path Path on file or directory.

optional arguments:
-h, --help show this help message and exit
--verbose, -v Verbose mode.
--version show program's version number and exit
--format {pep8,pylint}, -f {pep8,pylint}
Error format.
--select SELECT, -s SELECT
Select errors and warnings. (comma-separated)
--linters LINTERS, -l LINTERS
Select linters. (comma-separated). Choices are
--ignore IGNORE, -i IGNORE
Ignore errors and warnings. (comma-separated)
--skip SKIP Skip files by masks (comma-separated, Ex.
Set mccabe complexity.
--report REPORT, -r REPORT
Filename for report.
--hook Install Git (Mercurial) hook.
--options OPTIONS, -o OPTIONS
Select configuration file. By default is

.. _modeline:

File modeline

You can set :ref:`options` for **Pylama** inside a source files.


.. Somethere in code
# lint_ignore=W:lint_select=W301

Disable code checking for current file: ::

.. Somethere in code
# lint=0

.. _skiplines:

Skip lines

Just add `# noqa` in end of line for ignore. ::

.. Somethere in code
x=d+34 # noqa

.. _config:

Configuration file

When starting **Pylama** try loading configuration file. By default: `<CURDIR>/pylama.ini`,
but you set it with "-o" option.

Section `main` contains a global options (see :ref:`options`), like `linters` and `skip`.

Other sections could set :ref:`modeline` for a custom files by filepath mask.

Example: `pylama.ini` ::

format = pylint
skip = */.tox/*,*/.env/*
linters = pylint,mccabe

lint_ignore = C901,R0914,W0212
lint_select = R

lint_ignore = C0110

lint = 0

Writing a linter

You can write a custom extension for Pylama.
Custom linter should be a python module. Name should be starts from 'pylama_'.

In '' should be defined 'pylama.linter' entry point. ::

# ...
'pylama.linter': ['lintername = pylama_lintername.main:Linter'],
# ...

'Linter' should be instance of 'pylama.lint.Linter' class.
Must implemented two methods:

'allow' take a path and returned true if linter could check this file for errors.
'run' take a path and meta keywords params and return list of errors.


Just virtual 'WOW' checker. ::

install_requires=[ 'setuptools' ],
'pylama.linter': ['wow = pylama_wow.main:Linter'],
# ...
) ::

from pylama.lint import Linter as BaseLinter

class Linter(BaseLinter):

def allow(self, path):
return 'wow' in path

def run(self, path, **meta):
with open(path) as f:
if 'wow' in
return [{
lnum: 0,
col: 0,
text: 'Wow has been finded.',
type: 'WOW'

.. _bagtracker:

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at

.. _contributing:


Development of adrest happens at github:

.. _contributors:



.. _license:


Licensed under a `BSD license`_.

.. _links:

.. _BSD license:
.. _Mccabe:
.. _PEP257:
.. _PEP8:
.. _PyFlakes:
.. _Pylint:
.. _gjslint:
.. _klen:
.. |logo| image::
:width: 100

Project details

Release history Release notifications | RSS feed

This version


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pylama, version 2.0.4
Filename, size File type Python version Upload date Hashes
Filename, size pylama-2.0.4.tar.gz (58.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page