All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
3 `vim-flake8` is a Vim plugin that runs the currently open file through Flake8,
4 a static syntax and style checker for Python source code. It supersedes both
5 [vim-pyflakes](https://github.com/nvie/vim-pyflakes) and
6 [vim-pep8](https://github.com/nvie/vim-pep8).
8 Flake8 is a wrapper around PyFlakes (static syntax checker), PEP8 (style
9 checker) and Ned's MacCabe script (complexity checker).
14 Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using
15 it already. Then, simply put the contents of this repository in your
16 `~/.vim/bundle` directory.
21 2. Press `<F7>` to run `flake8` on it
23 It shows the errors inside a quickfix window, which will allow your to quickly
24 jump to the error locations by simply pressing [Enter].
29 If you don't want to use the `<F7>` key for flake8-checking, simply remap it to
30 another key. It autodetects whether it has been remapped and won't register
31 the `<F7>` key if so. For example, to remap it to `<F3>` instead, use:
33 autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
38 A tip might be to run the Flake8 check every time you write a Python file, to
39 enable this, add the following line to your `.vimrc` file (thanks
40 [Godefroid](http://github.com/gotcha)!):
42 autocmd BufWritePost *.py call Flake8()
44 To ignore errors, in your .vimrc:
46 g:flake8_ignore=E501,W293
48 This plugin goes well together with the following plugin:
50 - [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`