Metadata-Version: 1.1
Name: git-pre-commit-hook
Version: 0.0.11
Summary: pre-commit hook for Git
Home-page: https://github.com/evvers/git-pre-commit-hook
Author: Evgeny Vereshchagin
Author-email: evvers@ya.ru
License: MIT
Description: Hook that blocks bad commits.
        Useful for Python-development.
        
        Installation
        ------------
        
        You can install, upgrade, uninstall git-pre-commit-hook
        with these commands::
        
          $ pip install git-pre-commit-hook
          $ pip install --upgrade git-pre-commit-hook
          $ pip uninstall git-pre-commit-hook
        
        Features
        ---------
        
        * Work fine with initial commit.
        * Work fine with all filenames.
        * Work with index contents instead of working copy.
        * Plugin architecture: adding new checks is easy.
        * Builtin plugins for:
        
          * validate json files
          * validate Python-code with
            `flake8 <https://pypi.python.org/pypi/flake8/>`_
            (
            `mccabe plugin <https://pypi.python.org/pypi/mccabe/>`_
            is enabled
            )
            and
            `pep8-naming <https://pypi.python.org/pypi/pep8-naming/>`_
          * validate Python-code with
            `frosted <https://pypi.python.org/pypi/frosted/>`_
          * validate .rst files with
            `restructuredtext_lint <https://pypi.python.org/pypi/restructuredtext_lint>`_
          * validate .ini files with
            `configparser <https://docs.python.org/2.7/library/configparser.html>`_
          * validate .yaml files with `PyYAML <https://pypi.python.org/pypi/PyYAML>`_
          * validate .xml files with
            `xml.etree.ElementTree <https://docs.python.org/2.7/library/xml.etree.elementtree.html>`_
          * check filesize
        
        Examples
        --------
        
        Install hook to current Git-repository::
        
          git-pre-commit-hook install \
            --plugin flake8 \
            --plugin frosted \
            --plugin json \
            --plugin file_size \
            --plugin rst \
            --plugin yaml
        
        Installed hook rejects commits:
        
        * if any file has size greater than 10MB
        * if files with .json extension contains invalid JSON
        * if Python-code doesn't pass check with flake8 (with pep8-naming)
        * if Python-code doesn't pass check with frosted
        * if files with .rst extension contains invalid RST
        * if files with .yaml extension contains invalid YAML
        
        List available plugins::
        
          git-pre-commit-hook list-plugins
        
        Show information about plugin::
        
          git-pre-commit-hook show-plugin-info json
        
        
        Contributing
        ------------
        
        1. Fork `git-pre-commit-hook <https://github.com/evvers/git-pre-commit-hook>`_
        
        2. Clone your fork
        
        3. Install tox::
        
            pip install tox
        
        4. Create development environment::
        
            tox -e devenv
            source devenv/bin/activate
        
        5. Edit code
        
        6. Run tests::
        
            tox
        
        7. Send pull request
        
        Links
        -----
        
        * `Fork me on GitHub <https://github.com/evvers/git-pre-commit-hook>`_
        
Keywords: git pre-commit hook pep8 pep8-naming flake8 mccabe frosted
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Quality Assurance
