https://github.com/xuhdev/flake8-executable

A Flake8 plugin for checking executable permissions and shebangs.
https://github.com/xuhdev/flake8-executable

Last synced: 13 days ago
JSON representation

A Flake8 plugin for checking executable permissions and shebangs.

• Host: GitHub
• URL: https://github.com/xuhdev/flake8-executable
• Owner: xuhdev
• License: lgpl-3.0
• Created: 2019-06-23T06:08:15.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-25T10:34:04.000Z (7 months ago)
• Last Synced: 2024-05-01T14:50:11.320Z (6 months ago)
• Language: Python
• Homepage: https://pypi.org/project/flake8-executable/
• Size: 89.8 KB
• Stars: 18
• Watchers: 2
• Forks: 2
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: COPYING

Awesome Lists containing this project

• awesome-flake8-extensions - flake8-executable - Plugin for checking executable permissions and shebangs. (Comments)

README

        
# flake8-executable

[![Pyversions](https://img.shields.io/pypi/pyversions/flake8-executable.svg?style=flat-square)](https://pypi.python.org/pypi/flake8-executable)

![PyPI](https://img.shields.io/pypi/v/flake8-executable.svg)

![PyPI - Downloads](https://img.shields.io/pypi/dm/flake8-executable)

[![Build Status](https://ci.appveyor.com/api/projects/status/h6mucl894w6dx7d0?svg=true)](https://ci.appveyor.com/project/xuhdev/flake8-executable)

Very often, developers mess up the executable permissions and shebangs of Python files. For example,

sometimes the executable permission was accidentally granted, sometimes it is forgotten.

This is a [Flake8][] plugin that ensures the executable permissions and shebangs of Python files are

correctly set. Specifically, it checks the following errors:

- EXE001: Shebang is present but the file is not executable.

- EXE002: The file is executable but no shebang is present.

- EXE003: Shebang is present but does not contain "python".

- EXE004: There is whitespace before shebang.

- EXE005: There are blank or comment lines before shebang.

## Installation

Run:

    pip install flake8-executable

Or through `pre-commit` with the `.pre-commit-config.yaml`:

```yaml

repos:

-   repo: https://github.com/PyCQA/flake8

    rev: 6.0.0  # replace with the latest flake8 release

    hooks:

    -   id: flake8

        additional_dependencies:

        - flake8-executable

```

## Usage

Normally, after flake8-executable is installed, invoking flake8 will also run this plugin. For more

details, check out the [Flake8 plugin page][].

## Copyright and License

Copyright (c) 2019 Hong Xu 

flake8-executable is free software: you can redistribute it and/or modify it under the terms of the

GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of

the License, or (at your option) any later version.

flake8-executable is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with

flake8-executable. If not, see .

[Flake8]: https://flake8.pycqa.org/

[Flake8 plugin page]: https://flake8.pycqa.org/en/latest/user/using-plugins.html