Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AtomLinter/linter-flake8
Linting Python files on the fly using flake8 with Atom
https://github.com/AtomLinter/linter-flake8
Last synced: 6 days ago
JSON representation
Linting Python files on the fly using flake8 with Atom
- Host: GitHub
- URL: https://github.com/AtomLinter/linter-flake8
- Owner: AtomLinter
- License: mit
- Archived: true
- Created: 2014-07-11T07:30:25.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-07-28T17:11:59.000Z (over 1 year ago)
- Last Synced: 2024-08-02T08:06:56.207Z (4 months ago)
- Language: JavaScript
- Size: 840 KB
- Stars: 104
- Watchers: 10
- Forks: 45
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# linter-flake8
[](https://travis-ci.org/AtomLinter/linter-flake8)
linter-flake8 is a [flake8](https://pypi.python.org/pypi/flake8) provider for
[linter](https://github.com/atom-community/linter).
## Installation
To use this plugin `flake8` will need to be installed on your
system. If it is not already installed, you can install
[flake8](https://pypi.python.org/pypi/flake8) by typing the following in a
terminal:
```ShellSession
pip install flake8
```
You can then install this package from with Atom or by typing:
```ShellSession
$ apm install linter-flake8
```
_Note: If the `linter` package is not currently installed, it will be installed
for you._
### Built-in docstrings check (Optional)
To include built-in docstrings (pep257) support you will also need to install:
```ShellSession
pip install flake8-docstrings
```
### OpenStack Style Guidelines check (Optional)
To support
[OpenStack Style Guidelines](http://google.github.io/styleguide/pyguide.html),
you will also need to install the
[hacking](https://github.com/openstack-dev/hacking) module:
```ShellSession
pip install hacking
```
### Virtualenv
To ensure `flake8` targets the proper Python version for each project you work
on, it is highly recommended to install `flake8` in each project's
[virtualenv](https://virtualenv.pypa.io/en/latest/):
* If you are okay with installing `flake8` inside each virtualenv, just do
that.
* If you'd rather use the system-wide `flake8` versions (e.g. `flake8` and
`flake8-python2`), create a `flake8` symlink in each virtualenv pointing to
your desired flake8 version. For example: `ln -s /usr/bin/flake8-python2
~/.virtualenvs/random_python2_project/bin/flake8`
Then [activate your virtualenv](https://virtualenv.pypa.io/en/latest/userguide.html#activate-script)
from the command line before starting Atom, and you're good to go!
## Settings
You can configure linter-flake8 like any [Atom](https://atom.io/) package by
editing the settings in _Atom -> Preferences -> Packages -> linter-flake8_.
Or if you prefer you can use Atom _config.cson_ file _~/.atom/config.cson_
(click _Open Your Config_ in _Atom_ menu).
If you installed `flake8` in a location not in your `$PATH`, the Settings panel
will let you specify where it lives. For example:
```cson
'linter-flake8':
'executablePath': '/usr/bin/flake8'
```
The `executablePath` setting may use `$PROJECT` and `$PROJECT_NAME` for the path or name of the current project, respectively.
### Project configuration files
Linter also supports reading `flake8` configuration files. To use them, you
need specify their names manually into _Config Files Names_ in the package
settings. Note that package settings from Settings panel will be **ignored** if
a configuration file was found.
