Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wistful/SublimeAutoPEP8

Automatically formats Python code to conform to the PEP 8 style guide using autopep8 and pep8 modules
https://github.com/wistful/SublimeAutoPEP8

Last synced: about 2 months ago
JSON representation

Automatically formats Python code to conform to the PEP 8 style guide using autopep8 and pep8 modules

Host: GitHub
URL: https://github.com/wistful/SublimeAutoPEP8
Owner: wistful
Archived: true
Created: 2012-08-08T11:43:16.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2022-02-01T06:36:27.000Z (over 2 years ago)
Last Synced: 2024-06-20T06:44:44.478Z (3 months ago)
Language: Python
Homepage:
Size: 783 KB
Stars: 144
Watchers: 5
Forks: 23
Open Issues: 5
Metadata Files:
- Readme: Readme.md

Awesome Lists containing this project

README

### Sublime Auto PEP8 Formatting

**Note**: project is no longer supported.

## About
Automatically formats Python code to conform to the PEP 8 style guide using [autopep8](https://github.com/hhatto/autopep8) library.

**Supports ST3 only**.

**Note**: The _walrus_(`if thing := foo.bar.baz: pass`) operator is not supported.
Auto-formatting is running by SublimeText python interpreter,
which is locked to version 3.3, and _walrus_ operator is supporter starting python3.8.

## Features
+ format / preview code according PEP8
+ format / preview selected text
+ format / preview all python modules in folder
+ side bar menu
+ format code while saving

## Installing
The easiest way to install AutoPEP8 in through Package Control,
which can be found at this site: [http://wbond.net/sublime_packages/package_control](http://wbond.net/sublime_packages/package_control).

Once you install Package Control, restart ST3 and bring up the Command Palette (`Command+Shift+P` on OS X, `Control+Shift+P` on Linux/Windows). Select "Package Control: Install Package", wait while Package Control fetches the latest package list, then select AutoPEP8 when the list appears.

## Pep8(pycodestyle) configuration
The extenstion supports both `--global-config` and `--ignore-local-config` options from the [autopep8](https://github.com/hhatto/autopep8).

## Settings
```javascript
{

"max-line-length": 79,

// Do not fix these errors / warnings(e.g. E4, W)
"ignore": "",

// Select errors / warnings(e.g. E4, W)
"select": "",

// Number of spaces per indent level
"indent-size": 4,

// Don't look for and apply local config files;
// if false, defaults are updated with any config files in the project's root directory.
"ignore-local-config": false,

// Path to a global pep8 config file;
// if this file doesnot exist then this is ignored.
"global-config": "",

// Hang closing bracket instead of matching indentation of opening bracket's line.
"hang-closing": false,

// Specifies whether or not format files once they saved.
"format_on_save": false,

// If true - open new output panel with format/preview results.
"show_output_panel": true,

// Format/Preview menu items only appear for views
// with syntax from `syntax_list`
// value is base filename of the .tmLanguage syntax files
"syntax_list": ["Python"],

// The value shows how deep the plugin should look for *.py files
// before disabling "Preview" and "Format" items in the Side Bar "AutoPep8" Context Menu.
"file_menu_search_depth": 3, // max depth to search python files

// If value is false(default)
// then formatter doesn't treat absence of bottom empty line as an error
// and doesn't try to fix it.
"avoid_new_line_in_select_mode": false,

// For debug purporse only.
"debug": false,
"logfile": "/tmp/sublimeautopep8.log" // File to store debug messages.
}
```

## Using

+ **SideBar** - right click on the file(s) or folder(s)
+ **Active view** - right click on the view
+ **Selected text** - right click on the selected text
+ **On Save** - provide by settings: option `format_on_save`
+ **Command Palette** - bring up the Command Palette and select `PEP8: Format Code` or `PEP8: Preview Changes`
+ **Hotkeys** - `Command/Control + Shift + 8` to format code, `Command/Control + 8` to preview changes