ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-pep​8

by SublimeLinter ST3

SublimeLinter plugin for python, using pep8.

Details

Installs

  • Total 57K
  • Win 18K
  • OS X 22K
  • Linux 18K
Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5
Windows 30 19 17 24 37 52 29 45 16 16 22 24 27 30 28 22 16 20 25 21 18 16 23 13 17 21 26 22 26 26 10 14 19 25 26 16 31 18 18 28 26 21 25 22 12 15
OS X 20 27 16 18 49 65 50 49 27 11 12 22 17 19 21 15 16 14 21 29 21 11 20 8 9 26 25 20 26 32 14 20 27 26 24 29 15 14 18 27 32 26 20 26 19 20
Linux 15 22 21 21 22 39 25 28 17 20 18 21 24 20 21 8 10 18 15 15 19 17 17 9 7 14 23 18 20 14 15 17 19 16 19 14 11 9 10 25 17 24 29 13 19 13

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-pep8

Build Status

This linter plugin for SublimeLinter provides an interface to pep8. It will be used with files that have the “Python” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before installing this plugin, you must ensure that pep8 is installed on your system. To install pep8, do the following:

  1. For best performance, install Python 3 and pip.

  2. Install pep8 by typing the following in a terminal, replacing '3.x' with the available version of pip:

[sudo] pip-3.x install pep8

Note: This plugin requires pep8 1.4.6 or later.

Linter configuration

In order for pep8 to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once pep8 is installed and configured, you can proceed to install the SublimeLinter-pep8 plugin if it is not yet installed.

Plugin installation

Please use Package Control 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.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette 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.

  2. 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.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

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.

Setting Description Inline Setting Inline Override
ignore A comma-separated list of error codes to ignore
select A comma-separated list of error codes to select, overrides ignore
max-line-length The maximum allowed line length. null uses the PEP8 default of 79.

Implementing per-project settings

Typically you will want to configure pep8 on a per-project basis to conform to the coding style for all files in that project. Usually you want to ignore certain pep8 warnings. First you need to find the pep8 error codes from the pep8 documentation. Then you need to configure the pep8 linter to ignore those warnings.

For example, let’s say your project requires python 2.7+, you want the maximum line length to be 512, and you want to ignore warnings about visual indents (pep8 errors E127 and E128):

  • If you have not already created a project in Sublime Text, select Project -> Save Project As....

  • Select Project -> Edit Project.

  • At the top level of the project’s JSON data, add the following:

    "SublimeLinter":
    {
        "@python": 2.7,
        "linters":
        {
            "pep8":
            {
                "@disable": false,
                "ignore": "E127,E128",
                "max-line-length": 512
            }
        }
    }
    
  • Save the file.

Any time you edit the project and change a linter’s settings, all open files that use that linter will be re-linted to reflect the new settings.

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.

Thank you for helping out!