FIXME and TODO checker. Plugin for flake8.
Project description
# flake8-fixme
[![PyPI](https://img.shields.io/pypi/v/flake8-fixme.svg)](https://pypi.python.org/pypi/flake8-fixme)
[![PyPI](https://img.shields.io/pypi/pyversions/flake8-fixme.svg)](https://pypi.python.org/pypi/flake8-fixme)
[![codecov](https://codecov.io/gh/tommilligan/flake8-fixme/branch/master/graph/badge.svg)](https://codecov.io/gh/tommilligan/flake8-fixme/branch/master)
![CircleCI branch](https://img.shields.io/circleci/project/github/tommilligan/flake8-fixme/master.svg)
Check for FIXME and other temporary comment notes.
This module provides a plugin for `flake8`, the Python code checker.
> This module was inspired by [flake8-todo](https://github.com/schlamar/flake8-todo)
## Installation
Install with pip:
```bash
pip install flake8-fixme
```
The plugin officially supports Python `>= 3.6` and `flake8 >= 3`.
You may find other Python 3 versions work as well.
## Usage
The plugin finds temporary comments you may not want to commit:
```python
def my_function():
# FIXME actual implementation here!
pass
```
```log
./my_file.py:2:7: T100 Fixme found (FIXME)
```
Each word has a seperate warning so you can adjust your workflow. We like to allow committing `TODO`s, but deny committing `FIXME`s.
## Changelog
### 1.0.0
#### Breaking changes
Upgrading to `flake8-fixme` from `flake8-todo` has the following breaking changes:
- error codes have been changed as follows:
- `T100`: line contains `FIXME`
- `T101`: line contains `TODO`
- `T102`: line contains `XXX`
- a line containing multiple words will raise an error for each word
- drop support for Python `2.7`
[![PyPI](https://img.shields.io/pypi/v/flake8-fixme.svg)](https://pypi.python.org/pypi/flake8-fixme)
[![PyPI](https://img.shields.io/pypi/pyversions/flake8-fixme.svg)](https://pypi.python.org/pypi/flake8-fixme)
[![codecov](https://codecov.io/gh/tommilligan/flake8-fixme/branch/master/graph/badge.svg)](https://codecov.io/gh/tommilligan/flake8-fixme/branch/master)
![CircleCI branch](https://img.shields.io/circleci/project/github/tommilligan/flake8-fixme/master.svg)
Check for FIXME and other temporary comment notes.
This module provides a plugin for `flake8`, the Python code checker.
> This module was inspired by [flake8-todo](https://github.com/schlamar/flake8-todo)
## Installation
Install with pip:
```bash
pip install flake8-fixme
```
The plugin officially supports Python `>= 3.6` and `flake8 >= 3`.
You may find other Python 3 versions work as well.
## Usage
The plugin finds temporary comments you may not want to commit:
```python
def my_function():
# FIXME actual implementation here!
pass
```
```log
./my_file.py:2:7: T100 Fixme found (FIXME)
```
Each word has a seperate warning so you can adjust your workflow. We like to allow committing `TODO`s, but deny committing `FIXME`s.
## Changelog
### 1.0.0
#### Breaking changes
Upgrading to `flake8-fixme` from `flake8-todo` has the following breaking changes:
- error codes have been changed as follows:
- `T100`: line contains `FIXME`
- `T101`: line contains `TODO`
- `T102`: line contains `XXX`
- a line containing multiple words will raise an error for each word
- drop support for Python `2.7`
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
flake8-fixme-1.0.0.tar.gz
(2.4 kB
view hashes)
Built Distribution
Close
Hashes for flake8_fixme-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8b33ba44cdbf5b121ed3f985490637f745d8b4eaa2a0a1b36602ad3d74e0bb6 |
|
MD5 | 4f8f72f94cf4f3445793c77aa1d04d56 |
|
BLAKE2b-256 | d6d2b41513a8ab74b224b73e66b677f40bb7a3833b503eb2e3981b61d5457c8e |