<commit_before># linter-flake8 package

This is a **linter-flake8** plugin for [Linter](https://github.com/AtomLinter/Linter). It
is an interface to [flake8](https://pypi.python.org/pypi/flake8).

![img](https://raw.githubusercontent.com/badray/linter-flake8/master/in_action.gif)

### Requirements
*Linter* package must be installed in order to use this plugin. If *Linter* is not
installed, please follow the instructions [here](https://github.com/AtomLinter/Linter).

### Installation
To use a plugin, you must ensure that `flake8` is installed on your
system.

Install [flake8](https://pypi.python.org/pypi/flake8) by typing the following
in a terminal:
   ```
   pip install flake8
   ```

Install plugin by typing:
   ```
   $ apm install linter-flake8
   ```

##### Bult-in docstrings check (Optional)
To include built-in docstrings (pep257) support you will also need to install:
   ```
   pip install flake8-docstrings
   ```
or:
   ```
   pip install flake8-pep257
   ```

##### OpenStack Style Guidelines check (Optional)
To support [OpenStack Style Guidelines](http://google-styleguide.googlecode.com/svn/trunk/pyguide.html), you will also need to install [hacking](https://github.com/openstack-dev/hacking) module:
  ```
  pip install hacking
  ```

### Settings
You can configure linter-flake8 as nearly all [Atom](https://atom.io/) modules by editing plugin settings in *Atom->Preferences->Packages->linter-flake-8*.

![img](https://raw.githubusercontent.com/badray/linter-flake8/master/screenshot_settings.png)

Or if you prefere you can use Atom *config.cson* file *~/.atom/config.cson* (click *Open Your Config*
in *Atom* menu).

In configuration you can specify executable directory if node hasn't it in **$PATH**. Example:

```
'linter-flake8':
  'executableDir': '/usr/local/bin/'
```

### Project configuration files
Linter also supports reading flake8 configuration files. To use them, you need specify their names manually into *Config Files Names* in plugin settings. Please take a note, that  plugin settings from configuration panel will be **ignored** if configuration file was found.

![img](https://raw.githubusercontent.com/badray/linter-flake8/master/screenshot_config_names.png)

## Donation
[![Share the love!](https://chewbacco-stuff.s3.amazonaws.com/donate.png)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KXUYS4ARNHCN8)
<commit_msg>:art: Cleanup README<commit_after>linter-flake8
=============

linter-flake8 is a [flake8](https://pypi.python.org/pypi/flake8 provider for [Linter](https://github.com/AtomLinter/Linter).

![img](https://cloud.githubusercontent.com/assets/4278113/8768482/52f975c6-2e3f-11e5-87e4-27c8359fd36c.gif)

### Requirements
Linter package must be installed in order to use this plugin. If it's not
installed, please follow the instructions [here](https://github.com/AtomLinter/Linter).

### Installation
To use a plugin, you must ensure that `flake8` is installed on your
system.

Install [flake8](https://pypi.python.org/pypi/flake8) by typing the following
in a terminal:
   ```
   pip install flake8
   ```

Install plugin by typing:
   ```
   $ apm install linter-flake8
   ```

##### Bult-in docstrings check (Optional)
To include built-in docstrings (pep257) support you will also need to install:
   ```
   pip install flake8-docstrings
   ```
or:
   ```
   pip install flake8-pep257
   ```

##### OpenStack Style Guidelines check (Optional)
To support [OpenStack Style Guidelines](http://google-styleguide.googlecode.com/svn/trunk/pyguide.html), you will also need to install [hacking](https://github.com/openstack-dev/hacking) module:
  ```
  pip install hacking
  ```

### Settings
You can configure linter-flake8 as nearly all [Atom](https://atom.io/) modules by editing plugin settings in *Atom->Preferences->Packages->linter-flake-8*.

![img](https://cloud.githubusercontent.com/assets/4278113/8768488/91fffae2-2e3f-11e5-9783-9513b882cbc0.png)

Or if you prefere you can use Atom *config.cson* file *~/.atom/config.cson* (click *Open Your Config*
in *Atom* menu).

In configuration you can specify executable directory if node hasn't it in **$PATH**. Example:

```
'linter-flake8':
  'executableDir': '/usr/local/bin/'
```

### Project configuration files
Linter also supports reading flake8 configuration files. To use them, you need specify their names manually into *Config Files Names* in plugin settings. Please take a note, that  plugin settings from configuration panel will be **ignored** if configuration file was found.

![img](https://cloud.githubusercontent.com/assets/4278113/8768510/0d3769f2-2e40-11e5-8e27-d31991973246.png)

{'fraction_non_alphanumeric': 0.1328158689090125, 'fraction_numerical': 0.03406640793445451, 'mean_word_length': 4.6504263093788065, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 20, 'lorem ipsum': 0, 'www.': 1, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4163080', 'n_tokens_mistral': 1593, 'n_tokens_neox': 1498, 'n_words': 425}