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](http://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes
9 (static syntax checker), PEP8 (style checker)
10 and Ned's MacCabe script (complexity checker).
15 Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using
16 it already. Make sure you've installed the [flake8](http://pypi.python.org/pypi/flake8/) package.
17 Then, simply put the contents of this repository in your
18 `~/.vim/bundle` directory.
23 2. Press `<F7>` to run `flake8` on it
25 It shows the errors inside a quickfix window, which will allow your to quickly
26 jump to the error locations by simply pressing [Enter].
31 If you don't want to use the `<F7>` key for flake8-checking, simply remap it to
32 another key. It autodetects whether it has been remapped and won't register
33 the `<F7>` key if so. For example, to remap it to `<F3>` instead, use:
35 autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
37 To ignore errors, in your .vimrc:
39 let g:flake8_ignore="E501,W293"
41 If you want to change the max line length for PEP8:
43 let g:flake8_max_line_length=99
45 To set the maximum [McCabe complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) before a warning is issued:
47 let g:flake8_max_complexity=10
49 To cutomize the location of your flake8 binary, set `g:flake8_cmd`:
51 let g:flake8_cmd="/opt/strangebin/flake8000"
56 A tip might be to run the Flake8 check every time you write a Python file, to
57 enable this, add the following line to your `.vimrc` file (thanks
58 [Godefroid](http://github.com/gotcha)!):
60 autocmd BufWritePost *.py call Flake8()
62 This plugin goes well together with the following plugin:
64 - [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`