Metadata-Version: 2.1
Name: flake8-fixme
Version: 1.1.1
Summary: Check for FIXME, TODO and other temporary developer notes. Plugin for flake8.
Home-page: https://github.com/tommilligan/flake8-fixme
Author: Tom Milligan
Author-email: tommilligan@users.noreply.github.com
License: Apache-2.0
Keywords: flake8 plugin fixme todo xxx hack
Platform: UNKNOWN
Classifier: Framework :: Flake8
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Quality Assurance
Description-Content-Type: text/markdown

# 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)](https://circleci.com/gh/tommilligan/flake8-fixme)

Check for FIXME, TODO and other temporary developer 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.7`.
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.2

#### Enhancements

- development pipeline now runs integration tests with flake8, for
  - locally built package (all builds)
  - package downloaded from pypi (after version release)

### 1.0.1

#### Bugfixes

- fixed pypi packaging not picking up source files
- fixed setup.py not loading markdown readme correctly

### 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`