# flake8-fixme
[](https://pypi.python.org/pypi/flake8-fixme)
[](https://pypi.python.org/pypi/flake8-fixme)
[](https://codecov.io/gh/tommilligan/flake8-fixme/branch/master)
[](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`
Raw data
{
"_id": null,
"home_page": "https://github.com/tommilligan/flake8-fixme",
"name": "flake8-fixme",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "flake8 plugin fixme todo xxx hack",
"author": "Tom Milligan",
"author_email": "tommilligan@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/58/96/51adbf26b1cc4c2f3a434fa06972a6bc9b3d96f6a4c04dfe9a604b5ce10e/flake8-fixme-1.1.1.tar.gz",
"platform": "",
"description": "# flake8-fixme\n\n[](https://pypi.python.org/pypi/flake8-fixme)\n[](https://pypi.python.org/pypi/flake8-fixme)\n[](https://codecov.io/gh/tommilligan/flake8-fixme/branch/master)\n[](https://circleci.com/gh/tommilligan/flake8-fixme)\n\nCheck for FIXME, TODO and other temporary developer notes.\n\nThis module provides a plugin for `flake8`, the Python code checker.\n\n> This module was inspired by [flake8-todo](https://github.com/schlamar/flake8-todo)\n\n## Installation\n\nInstall with pip:\n\n```bash\npip install flake8-fixme\n```\n\nThe plugin officially supports Python `>= 3.6` and `flake8 >= 3.7`.\nYou may find other Python 3 versions work as well.\n\n## Usage\n\nThe plugin finds temporary comments you may not want to commit:\n\n```python\ndef my_function():\n # FIXME actual implementation here!\n pass\n```\n\n```log\n./my_file.py:2:7: T100 Fixme found (FIXME)\n```\n\nEach word has a seperate warning so you can adjust your workflow. We like to allow committing `TODO`s, but deny committing `FIXME`s.\n\n## Changelog\n\n### 1.0.2\n\n#### Enhancements\n\n- development pipeline now runs integration tests with flake8, for\n - locally built package (all builds)\n - package downloaded from pypi (after version release)\n\n### 1.0.1\n\n#### Bugfixes\n\n- fixed pypi packaging not picking up source files\n- fixed setup.py not loading markdown readme correctly\n\n### 1.0.0\n\n#### Breaking changes\n\nUpgrading to `flake8-fixme` from `flake8-todo` has the following breaking changes:\n\n- error codes have been changed as follows:\n - `T100`: line contains `FIXME`\n - `T101`: line contains `TODO`\n - `T102`: line contains `XXX`\n- a line containing multiple words will raise an error for each word\n- drop support for Python `2.7`\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Check for FIXME, TODO and other temporary developer notes. Plugin for flake8.",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/tommilligan/flake8-fixme"
},
"split_keywords": [
"flake8",
"plugin",
"fixme",
"todo",
"xxx",
"hack"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c6a2f3c813f06cbc1b38b1a1e3647ae204254844c7f28ce9c8eaee053d14e43d",
"md5": "b86be9fe7a572367c9b6b581975600b8",
"sha256": "226a6f2ef916730899f29ac140bed5d4a17e5aba79f00a0e3ae1eff1997cb1ac"
},
"downloads": -1,
"filename": "flake8_fixme-1.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "b86be9fe7a572367c9b6b581975600b8",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7975,
"upload_time": "2019-05-06T19:06:44",
"upload_time_iso_8601": "2019-05-06T19:06:44.658390Z",
"url": "https://files.pythonhosted.org/packages/c6/a2/f3c813f06cbc1b38b1a1e3647ae204254844c7f28ce9c8eaee053d14e43d/flake8_fixme-1.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "589651adbf26b1cc4c2f3a434fa06972a6bc9b3d96f6a4c04dfe9a604b5ce10e",
"md5": "da9615dc99c3600f5193ce4d14d01fe1",
"sha256": "50cade07d27a4c30d4f12351478df87339e67640c83041b664724bda6d16f33a"
},
"downloads": -1,
"filename": "flake8-fixme-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "da9615dc99c3600f5193ce4d14d01fe1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3423,
"upload_time": "2019-05-06T19:06:45",
"upload_time_iso_8601": "2019-05-06T19:06:45.852331Z",
"url": "https://files.pythonhosted.org/packages/58/96/51adbf26b1cc4c2f3a434fa06972a6bc9b3d96f6a4c04dfe9a604b5ce10e/flake8-fixme-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-05-06 19:06:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tommilligan",
"github_project": "flake8-fixme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "flake8-fixme"
}
JSON
