|
| 1 | +SublimeLinter-pep8 |
| 2 | +========================= |
| 3 | + |
| 4 | +This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter3) provides an interface to the [pep8](https://github.com/jcrocholl/pep8). It will be used with files that have the “Python” syntax. |
| 5 | + |
| 6 | +## Installation |
| 7 | + |
| 8 | +### Linter installation |
| 9 | +Before installing this plugin, you must ensure that `pep8` is installed on your system. To install `pep8`, do the following: |
| 10 | + |
| 11 | +1. For best performance, install [Python 3](http://python.org) and [pip](http://www.pip-installer.org/en/latest/installing.html). |
| 12 | + |
| 13 | +1. Install `pep8` by typing the following in a terminal, replacing '3.x' with the available version of pip: |
| 14 | + ``` |
| 15 | + [sudo] pip-3.x install pep8 |
| 16 | + ``` |
| 17 | + |
| 18 | +Now you can proceed to install the SublimeLinter-pep8 plugin. |
| 19 | + |
| 20 | +### Plugin installation |
| 21 | +Please use [Package Control](https://sublime.wbond.net/installation) to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here. |
| 22 | + |
| 23 | +To install via Package Control, do the following: |
| 24 | + |
| 25 | +1. Within Sublime Text, bring up the [Command Palette](http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html) and type `install`. Among the commands you should see `Package Control: Install Package`. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins. |
| 26 | + |
| 27 | +1. When the plugin list appears, type `pep8`. Among the entries you should see `SublimeLinter-pep8`. If that entry is not highlighted, use the keyboard or mouse to select it. |
| 28 | + |
| 29 | +## Settings |
| 30 | +For general information on how SublimeLinter works with settings, please see [Settings](https://github.com/SublimeLinter/SublimeLinter.github.io/wiki/Settings). For information on generic linter settings, please see [Linter Settings](https://github.com/SublimeLinter/SublimeLinter.github.io/wiki/Linter-Settings). |
| 31 | + |
| 32 | +In addition to the standard SublimeLinter settings, SublimeLinter-pep8 provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be [used inline](https://github.com/SublimeLinter/SublimeLinter.github.io/wiki/Settings#inline-settings). |
| 33 | + |
| 34 | +|Setting|Description|Inline Setting|Inline Override| |
| 35 | +|:------|:----------|:------------:|:-------------:| |
| 36 | +|ignore|A comma-separated list of error codes to ignore| |✓| |
| 37 | +|select|A comma-separated list of error codes to select, overrides ignore| |✓| |
| 38 | +|max-line-length|The maximum allowed line length. `null` allows any length.|✓| | |
| 39 | + |
| 40 | +## Contributing |
| 41 | +If you would like to contribute enhancements or fixes, please do the following: |
| 42 | + |
| 43 | +1. Fork the plugin repository. |
| 44 | +1. Hack on a separate topic branch created from the latest `master`. |
| 45 | +1. Commit and push the topic branch. |
| 46 | +1. Make a pull request. |
| 47 | +1. Be patient. ;-) |
| 48 | + |
| 49 | +Please note that modications should follow these coding guidelines: |
| 50 | + |
| 51 | +- Indent is 4 spaces. |
| 52 | +- Code should pass flake8 and pep257 linters. |
| 53 | +- Vertical whitespace helps readability, don’t be afraid to use it. |
| 54 | + |
| 55 | +Thank you for helping out! |
0 commit comments