Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loadsmart/danger-pep8
A Danger plugin for Python's PEP 8
https://github.com/loadsmart/danger-pep8
danger lint pep8 python
Last synced: 4 months ago
JSON representation
A Danger plugin for Python's PEP 8
- Host: GitHub
- URL: https://github.com/loadsmart/danger-pep8
- Owner: loadsmart
- License: mit
- Archived: true
- Created: 2016-11-23T20:53:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-11T12:45:26.000Z (over 4 years ago)
- Last Synced: 2023-12-24T04:43:53.791Z (6 months ago)
- Topics: danger, lint, pep8, python
- Language: Ruby
- Homepage: https://www.python.org/dev/peps/pep-0008/
- Size: 42 KB
- Stars: 9
- Watchers: 7
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Lists
- awesome-danger - danger-pep8 - A Danger plugin for Python's PEP 8. (Plugins / Ruby (danger))
README
[](https://circleci.com/gh/loadsmart/danger-pep8)
**IMPORTANT: This repository is not being maintained anymore.**
# danger-pep8
Find [PEP 8](https://www.python.org/dev/peps/pep-0008/) issues in python files.
## Installation
### Via global gems
```
$ gem install danger-pep8
```
### Via Bundler
Add the following line to your Gemfile and then run `bundle install`:
```rb
gem 'danger-pep8'
```
## Usage
### Basic
Check for issues running the script from current directory. Prints a markdown table with all issues found:
```rb
pep8.lint
```
### Advanced
#### Running from a custom directory
Changes root folder from where script is running:
```rb
pep8.base_dir = "src"
pep8.lint
```
#### Use GitHub's inline comments instead of a markdown table
```rb
pep8.lint(use_inline_comments=true)
```
#### Running using a configuration file different than the usual
If you need to specify a different configuration file, use the `config_file` parameter below. Check [this link](http://flake8.pycqa.org/en/latest/user/configuration.html#configuration-locations) for more information about Configuration Locations.
```rb
pep8.config_file = ".flake8_ci"
pep8.lint
```
#### Printing a warning message with number of errors
Adds an entry onto the warnings/failures table:
```rb
pep8.count_errors
```
#### Defining a threshold of max errors
Warns if number of issues is greater than a given threshold:
```rb
pep8.threshold = 10
pep8.count_errors
```
Fails if number of issues is greater than a given threshold:
```rb
pep8.threshold = 10
pep8.count_errors(should_fail = true)
```
## Development
1. Clone this repo
2. Run `bundle install` to setup dependencies.
3. Run `bundle exec rake spec` to run the tests.
4. Use `bundle exec guard` to automatically have tests run as you make changes.
5. Make your changes.
## License
MIT