Metadata-Version: 1.1
Name: Better-Than-You-Found-It
Version: 0.8.2
Summary: PEP8 clean only the parts of the files which you have touched since the last commit, previous commit or branch.
Home-page: https://github.com/hayd/pep8radius
Author: Andy Hayden
Author-email: andyhayden1@gmail.com
License: MIT License
Description: pep8radius
        ----------
        
        `PEP8 <http://legacy.python.org/dev/peps/pep-0008/>`__ clean only the
        parts of the files touched since the last commit, a previous commit or
        branch.
        
        |Current PyPi Version| |MIT licensed| |Travis CI Status| |Coverage
        Status| |PyPi Monthly Downloads|
        
        Fixing the entire project of PEP8 infractions ("PEP8 storms") can lead
        to merge conflicts, add noise to merges / pull requests and break (git)
        blame. pep8radius solves this problem by fixing only those PEP8
        infractions incontained on the lines of the project which you've been
        working, leaving these sections "better than you found it" whilst
        keeping your commits focused on the areas of the codebase you were
        actually working on.
        
        Installation
        ------------
        
        From pip:
        
        .. code:: sh
        
            $ pip install pep8radius
        
        Usage
        -----
        
        .. figure:: https://cloud.githubusercontent.com/assets/1931852/4259885/18a7e75e-3b1a-11e4-9413-d92f9b170b70.gif
           :alt: Usage gif of pep8radius
        
           Usage gif of pep8radius
        
        -  Move to project directory
        -  Make some changes to the project
        -  Run ``pep8radius --diff       # view a diff of proposed fixed``
        -  Run ``pep8radius --in-place   # apply the fixes``
        -  Commit your changes
        
        Against a branch you can use the same syntax as with git diff:
        
        .. code:: sh
        
            $ pep8radius master   # branch name to compare against (compares against merge-base)
            $ pep8radius c12166f  # commit hash
        
            $ pep8radius master --in-place  # these work with other options too
        
        You can also fix docstrings
        (`PEP257 <http://legacy.python.org/dev/peps/pep-0257/>`__) using the
        `docformatter <https://pypi.python.org/pypi/docformatter>`__ option:
        
        .. code:: sh
        
            $ pep8radius --docformatter --diff
        
        *Note: can also use ``btyfi`` alias for ``pep8radius``.*
        
        --------------
        
        It can be nice to pipe the diff to
        `cdiff <https://pypi.python.org/pypi/cdiff>`__ (which makes diffs pretty
        and has lots of options):
        
        .. code:: sh
        
            $ pep8radius --diff --no-color | cdiff
            $ pep8radius --diff --no-color | cdiff --side-by-side
        
        | You can get strange results if you don't use no-color.
        | I actually use the following git alias (which allows ``git rad`` and
        ``git rad -i``):
        
        .. code:: sh
        
            [alias]
                rad = !pep8radius master --diff --no-color $@ | cdiff --side-by-side
        
        .. figure:: https://cloud.githubusercontent.com/assets/1931852/4259933/f0589480-3b1c-11e4-89cf-565c28da700a.png
           :alt: git rad
        
           git rad
        Requirements
        ------------
        
        pep8radius uses `autopep8 <https://pypi.python.org/pypi/autopep8>`__,
        and in turn `pep8 <https://pypi.python.org/pypi/pep8>`__. The
        docformatter option, to fix docstrings, uses
        `docformatter <https://pypi.python.org/pypi/docformatter>`__.
        
        VCS Support
        -----------
        
        `Git <http://git-scm.com/>`__, `Mecurial
        (hg) <http://mercurial.selenic.com/>`__, (tentatively)
        `Bazaar <http://bazaar.canonical.com/en/>`__. Please request support for
        other version control systems on
        `github <https://github.com/hayd/pep8radius/issues/5>`__.
        
        Options
        -------
        
        ::
        
            usage: pep8radius.py [-h] [--version] [-v] [-d] [-i] [-p n] [-a]
                                 [--experimental] [--exclude globs] [--list-fixes]
                                 [--ignore errors] [--select errors] [--max-line-length n]
                                 [--indent-size n] [--docformatter] [--no-blank]
                                 [--pre-summary-newline] [--force-wrap]
                                 [rev]
        
            positional arguments:
              rev                   commit or name of branch to compare against
        
            optional arguments:
              -h, --help            show this help message and exit
              --version             print version number and exit
              -v, --verbose         print verbose messages; multiple -v result in more
                                    verbose messages (passed to autopep8)
              -d, --diff            print the diff for the fixed source
              -i, --in-place        make the changes in place
              -f, --docformatter    fix docstrings for PEP257 using docformatter
              -p n, --pep8-passes n
                                    maximum number of additional pep8 passes (default:
                                    infinite)
              -a, --aggressive      enable non-whitespace changes; multiple -a result in
                                    more aggressive changes
              --experimental        enable experimental fixes
              --exclude globs       exclude file/directory names that match these comma-
                                    separated globs
              --list-fixes          list codes for fixes; used by --ignore and --select
              --ignore errors       do not fix these errors/warnings (default: E24)
              --select errors       fix only these errors/warnings (e.g. E4,W)
              --max-line-length n   set maximum allowed line length (default: 79)
              --indent-size n       number of spaces per indent level (default 4)
              --no-blank            do not add blank line after description; used by
                                    docformatter
              --pre-summary-newline
                                    add a newline before the summary of a multi-line
                                    docstring; used by docformatter
              --force-wrap          force descriptions to be wrapped even if it may result
                                    in a mess; used by docformatter
        
        *For more information about these options see
        `autopep8 <https://pypi.python.org/pypi/autopep8>`__.*
        
        .. |Current PyPi Version| image:: http://img.shields.io/pypi/v/pep8radius.svg
           :target: https://pypi.python.org/pypi/pep8radius
        .. |MIT licensed| image:: http://img.shields.io/badge/license-MIT-brightgreen.svg
           :target: http://choosealicense.com/licenses/mit/
        .. |Travis CI Status| image:: http://img.shields.io/travis/hayd/pep8radius.svg
           :target: https://travis-ci.org/hayd/pep8radius/builds
        .. |Coverage Status| image:: http://img.shields.io/coveralls/hayd/pep8radius.svg
           :target: https://coveralls.io/r/hayd/pep8radius
        .. |PyPi Monthly Downloads| image:: http://img.shields.io/pypi/dm/pep8radius.svg
           :target: https://pypi.python.org/pypi/pep8radius
        
Keywords: automation,pep8,format,autopep8,git,hg,mercurial
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
