Metadata-Version: 2.0
Name: formatter2
Version: 1.3.0
Summary: A Python source formatter that uses the tokenize library to ensure correctness
Home-page: https://github.com/WoLpH/python-formatter
Author: Rick van Hattem
Author-email: Wolph@wol.ph
License: BSD
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Requires-Dist: pep8

Readme
======

Introduction
------------

.. image:: https://travis-ci.org/WoLpH/python-formatter.png?branch=master
    :alt: Test Status
    :target: https://travis-ci.org/WoLpH/python-formatter

.. image:: https://coveralls.io/repos/WoLpH/python-formatter/badge.png?branch=master
    :alt: Coverage Status
    :target: https://coveralls.io/r/WoLpH/python-formatter?branch=master

`formatter2` is a Python formatter based on the `tokenize` library in Python.
Due to a bug with line continuations we are currently running a fork of the
`tokenize` library however.

During every format sequence the `compile` method is used to check if no code
has been broken, but backing up is still a good idea.

The library is made to be very extendable and configurable but it's still in 
the beginning phase. Eventually this will become a fully featured formatting 
tool for Python.

Install
-------

To install simply execute `python setup.py install` or `pip install
formatter2`.
If you want to run the tests first, run `nosetests`

Usage
-----

To format all of your code recursively (MAKE BACKUPS!):

    python-formatter -r DIRECTORY

Or:

    format-python -r DIRECTORY



