Metadata-Version: 2.4
Name: flake8-snippets
Version: 0.2
Summary: A flake8 extension to find any code snippets you don't like
Home-page: https://github.com/bitmazk/flake8-snippets
Author: Tobias Lorenz
Author-email: tobias.lorenz@bitmazk.com
License: The MIT License
Keywords: django,app,reusable,flake8,snippets,code,review
Platform: OS Independent
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: flake8
Requires-Dist: flake8-polyfill
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: requires-dist
Dynamic: summary

flake8-snippets
===============

A flake8 extension to find any code snippets you don't like.

Flake8 is a tool to combine different apps (like pep8) and therefore to
guarantee clean Python code.

Read more: http://flake8.readthedocs.org/en/latest/

Installation
------------

To get the latest stable release from PyPi

.. code-block:: bash

    $ pip install flake8-snippets

To get the latest commit from GitHub

.. code-block:: bash

    $ pip install -e git+git://github.com/bitmazk/flake8-snippets.git#egg=flake8_snippets


Usage
-----

Simply enhance the ``flake8`` command with the ``--snippet`` setting and add
a comma-separated list

.. code-block:: bash

    flake8 --statistics --snippets='# TODO' .

or

.. code-block:: bash

    flake8 --statistics --snippets='import ipdb,ipdb.set_trace()' .


Contribute
----------

If you want to contribute to this project, please perform the following steps

.. code-block:: bash

    # Fork this repository
    # Clone your fork
    $ mkvirtualenv -p python2.7 flake8-snippets
    $ python setup.py install

    $ git co -b feature_branch master
    # Implement your feature and tests
    $ git add . && git commit
    $ git push -u origin feature_branch
    # Send us a pull request for your feature branch
