Metadata-Version: 1.1
Name: pylava
Version: 0.1.0
Summary: Pylava -- Code audit tool for Python

Home-page:  https://github.com/pyfocus/pylava
Author: Pyfocus community
Author-email: UNKNOWN
License: MIT
Description: Pylava
        ######
        Pylava is intended to be a community maintained fork of
        `Pylama <https://github.com/klen/pylama>`_.
        
        Pylama does not work with Python 3.7 due to `this issue
        <https://github.com/klen/pylama/issues/123>`_. While there is a pull
        request to resolve the issue, it is not being merged into the project
        due to lack of maintenance. This fork named Pylava is meant for merging
        useful pull requests into the project, so that the project can satsify
        the current needs of Python developers.
        
        The README content below is mostly the original content from the README
        of Pylama. Thus many links in the README may refer to resources of the
        Pylama project. They will be updated to refer to resources of Pylava
        gradually as time permits. However it isn't a major problem because
        Pylava is meant to be a drop-in replacement for Pylama.
        
        While the original Pylama project uses the ``develop`` branch as the
        active development branch, this fork uses the ``master`` branch as the
        active development branch.
        
        **Credit:** Thanks to `Kirill Klenvo <https://github.com/klen>`_ for
        writing the original Pylama project.
        
        .. _description:
        
        Code audit tool for Python and JavaScript. Pylama wraps these tools:
        
        * pycodestyle_ (formerly pep8) © 2012-2013, Florent Xicluna;
        * pydocstyle_ (formerly pep257 by Vladimir Keleshev) © 2014, Amir Rachum;
        * PyFlakes_ © 2005-2013, Kevin Watters;
        * Mccabe_ © Ned Batchelder;
        * Pylint_ © 2013, Logilab (should be installed 'pylama_pylint' module);
        * Radon_ © Michele Lacchia
        * gjslint_ © The Closure Linter Authors (should be installed 'pylama_gjslint' module);
        
        .. _badges:
        
        .. image:: http://img.shields.io/travis/klen/pylama.svg?style=flat-square
            :target: http://travis-ci.org/klen/pylama
            :alt: Build Status
        
        .. image:: http://img.shields.io/coveralls/klen/pylama.svg?style=flat-square
            :target: https://coveralls.io/r/klen/pylama
            :alt: Coverals
        
        .. image:: http://img.shields.io/pypi/v/pylama.svg?style=flat-square
            :target: https://crate.io/packages/pylama
            :alt: Version
        
        .. image:: http://img.shields.io/gratipay/klen.svg?style=flat-square
            :target: https://www.gratipay.com/klen/
            :alt: Donate
        
        
        .. _documentation:
        
        Docs are available at https://pylava.readthedocs.org/. Pull requests with documentation enhancements and/or fixes are awesome and most welcome.
        
        
        .. _contents:
        
        .. contents::
        
        .. _requirements:
        
        Requirements:
        =============
        
        - Python (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`` - http://www.lfd.uci.edu/~gohlke/pythonlibs/
          (The curses library supplies a terminal-independent screen-painting and keyboard-handling facility for text-based terminals)
        
        
        .. _installation:
        
        Installation:
        =============
        **Pylama** could be installed using pip: ::
        ::
        
            $ pip install pylava
        
        
        .. _quickstart:
        
        Quickstart
        ==========
        
        **Pylama** is easy to use and really fun for checking code quality.
        Just run `pylava` and get common output from all pylava plugins (pycodestyle_, PyFlakes_ and etc)
        
        Recursive check the current directory. ::
        
            $ pylava
        
        Recursive check a path. ::
        
            $ pylava <path_to_directory_or_file>
        
        Ignore errors ::
        
            $ pylava -i W,E501
        
        .. note:: You could choose a group erros `D`,`E1` and etc or special errors `C0312`
        
        Choose code checkers ::
        
            $ pylava -l "pycodestyle,mccabe"
        
        Choose code checkers for JavaScript::
        
            $ pylava --linters=gjslint --ignore=E:0010 <path_to_directory_or_file>
        
        .. _options:
        
        Set Pylama (checkers) options
        =============================
        
        Command line options
        --------------------
        
        ::
        
            $ pylava --help
        
            usage: pylava [-h] [--verbose] [--version] [--format {pycodestyle,pylint}]
                          [--select SELECT] [--sort SORT] [--linters LINTERS]
                          [--ignore IGNORE] [--skip SKIP] [--report REPORT] [--hook]
                          [--async] [--options OPTIONS] [--force] [--abspath]
                          [paths [paths ...]]
        
            Code audit tool for python.
        
            positional arguments:
              paths                 Paths to files or directories for code check.
        
            optional arguments:
              -h, --help            show this help message and exit
              --verbose, -v         Verbose mode.
              --version             show program's version number and exit
              --format {pycodestyle,pylint}, -f {pycodestyle,pylint}
                                    Choose errors format (pycodestyle, pylint).
              --select SELECT, -s SELECT
                                    Select errors and warnings. (comma-separated list)
              --sort SORT           Sort result by error types. Ex. E,W,D
              --linters LINTERS, -l LINTERS
                                    Select linters. (comma-separated). Choices are
                                    mccabe,pycodestyle,pyflakes,pydocstyle.
              --ignore IGNORE, -i IGNORE
                                    Ignore errors and warnings. (comma-separated)
              --skip SKIP           Skip files by masks (comma-separated, Ex.
                                    */messages.py)
              --report REPORT, -r REPORT
                                    Send report to file [REPORT]
              --hook                Install Git (Mercurial) hook.
              --async               Enable async mode. Useful for checking a lot of
                                    files. Not supported by pylint.
              --options FILE, -o FILE
                                    Specify configuration file. Looks for pylava.ini,
                                    setup.cfg, tox.ini, or pytest.ini in the current
                                    directory.
              --force, -F           Force code checking (if linter doesnt allow)
              --abspath, -a         Use absolute paths in output.
        
        
        .. _modeline:
        
        File modelines
        --------------
        
        You can set options for **Pylama** inside a source file. Use
        pylava *modeline* for this.
        
        Format: ::
        
            # pylava:{name1}={value1}:{name2}={value2}:...
        
        
        ::
        
             .. Somethere in code
             # pylava:ignore=W:select=W301
        
        
        Disable code checking for current file: ::
        
             .. Somethere in code
             # pylava:skip=1
        
        Those options have a higher priority.
        
        .. _skiplines:
        
        Skip lines (noqa)
        -----------------
        
        Just add `# noqa` in end of line to ignore.
        
        ::
        
            def urgent_fuction():
                unused_var = 'No errors here' # noqa
        
        
        .. _config:
        
        Configuration file
        ------------------
        
        **Pylama** looks for a configuration file in the current directory.
        
        The program searches for the first matching ini-style configuration file in
        the directories of command line argument. Pylama looks for the configuration
        in this order: ::
        
            pylava.ini
            setup.cfg
            tox.ini
            pytest.ini
        
        The "--option" / "-o" argument can be used to specify a configuration file.
        
        Pylama searches for sections whose names start with `pylava`.
        
        The "pylava" section configures global options like `linters` and `skip`.
        
        ::
        
            [pylava]
            format = pylint
            skip = */.tox/*,*/.env/*
            linters = pylint,mccabe
            ignore = F0401,C0111,E731
        
        Set Code-checkers' options
        --------------------------
        
        You could set options for special code checker with pylava configurations.
        
        ::
        
            [pylava:pyflakes]
            builtins = _
        
            [pylava:pycodestyle]
            max_line_length = 100
        
            [pylava:pylint]
            max_line_length = 100
            disable = R
        
        See code-checkers' documentation for more info.
        
        
        Set options for file (group of files)
        -------------------------------------
        
        You could set options for special file (group of files)
        with sections:
        
        The options have a higher priority than in the `pylava` section.
        
        ::
        
            [pylava:*/pylava/main.py]
            ignore = C901,R0914,W0212
            select = R
        
            [pylava:*/tests.py]
            ignore = C0110
        
            [pylava:*/setup.py]
            skip = 1
        
        
        Pytest integration
        ==================
        
        Pylama has Pytest_ support. The package automatically registers itself as a pytest
        plugin during installation. Pylama also supports `pytest_cache` plugin.
        
        Check files with pylava ::
        
            pytest --pylava ...
        
        Recommended way to set pylava options when using pytest — configuration
        files (see below).
        
        
        Writing a linter
        ================
        
        You can write a custom extension for Pylama.
        Custom linter should be a python module. Name should be like 'pylava_<name>'.
        
        In 'setup.py', 'pylava.linter' entry point should be defined. ::
        
            setup(
                # ...
                entry_points={
                    'pylava.linter': ['lintername = pylava_lintername.main:Linter'],
                }
                # ...
            )
        
        'Linter' should be instance of 'pylava.lint.Linter' class.
        Must implement two methods:
        
        'allow' takes a path and returns true if linter can check this file for errors.
        'run' takes a path and meta keywords params and returns a list of errors.
        
        Example:
        --------
        
        Just a virtual 'WOW' checker.
        
        setup.py: ::
        
            setup(
                name='pylava_wow',
                install_requires=[ 'setuptools' ],
                entry_points={
                    'pylava.linter': ['wow = pylava_wow.main:Linter'],
                }
                # ...
            )
        
        pylava_wow.py: ::
        
            from pylava.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 f.read():
                            return [{
                                lnum: 0,
                                col: 0,
                                text: 'Wow has been finded.',
                                type: 'WOW'
                            }]
        
        
        Run pylava from python code
        ---------------------------
        ::
        
            from pylava.main import check_path, parse_options
        
            my_redefined_options = {...}
            my_path = '...'
            options = parse_options([my_path], **my_redefined_options)
            errors = check_path(options)
        
        
        .. _bagtracker:
        
        Bug tracker
        -----------
        
        If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/pyfocus/pylava/issues
        
        
        .. _contributing:
        
        Contributing
        ------------
        
        Development of `pylava` happens at GitHub: https://github.com/pyfocus/pylava (master branch)
        
        
        .. _contributors:
        
        Contributors
        ^^^^^^^^^^^^
        
        See AUTHORS_.
        
        
        .. _license:
        
        License
        -------
        Licensed under the `MIT License`_.
        
        
        .. _links:
        
        .. _AUTHORS: https://github.com/pyfocus/pylava/blob/develop/AUTHORS
        .. _MIT license: https://github.com/pyfocus/pylava/blob/master/LICENSE.rst
        .. _Mccabe: http://nedbatchelder.com/blog/200803/python_code_complexity_microtool.html
        .. _pydocstyle: https://github.com/PyCQA/pydocstyle/
        .. _pycodestyle: https://github.com/PyCQA/pycodestyle
        .. _PyFlakes: https://github.com/pyflakes/pyflakes
        .. _Pylint: http://pylint.org
        .. _Pytest: http://pytest.org
        .. _gjslint: https://developers.google.com/closure/utilities
        .. _Radon: https://github.com/rubik/radon
        
Keywords: pylint,pep8,pycodestyle,pyflakes,mccabe,linter,qa,pep257,pydocstyle
Platform: Any
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Natural Language :: Russian
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Code Generators
