# flake8-todos
Plugin for [flake8](http://flake8.pycqa.org/en/latest/) linter to check TODOs in the project.
Good:
```python
# TODO(gram): check performance
# https://github.com/orsinium-labs/flake8-todos/issues/1337
```
Bad:
```python
# FIXME idk how it works lol
```
Checks:
+ **T001**: use TODO instead of FIXME (or BUG) for consistency.
+ **T002**: add author into TODO ([motivation](https://dave.cheney.net/practical-go/presentations/qcon-china.html#_dont_comment_bad_code_rewrite_it)).
+ **T003**: add link on issue into TODO.
+ **T004**: missed colon in TODO.
+ **T005**: missed text in TODO.
+ **T006**: write TODO instead of ToDo (use upper case).
+ **T007**: missed space after colon in TODO.
## Installation
```bash
python3 -m pip install --user flake8-todos
```
## Usage
Check that plugin was added in your flake8:
```bash
$ python3 -m flake8 --version
3.7.7 (flake8-todos: 1.0.0, mccabe: 0.6.1, pycodestyle: 2.5.0, pyflakes: 2.1.1) CPython 3.6.7 on Linux
```
If you don't see `flake8-todos` in the previous command output, check that `flake8` and `flake8-todos` is installed in the same interpreter.
If everything is OK, run `flake8`:
```bash
python -m flake8 example.py
```
## License
+ The content of this repository contains a public fork of flake8-todos developed by [EclecticIQ B.V.](https://github.com/eclecticiq). Release 0.1.2 of the package was licensed under BSD 3-Clause License. File [LICENSE](LICENSE) contains the original license file.
+ The fork is distributed under the same license and conditions.
+ Release 0.1.2, all earlier releases, and corresponding source code are licensed under copyright "2019 EclecticIQ".
+ All the later changes and distributions starting from 0.1.4 inclusively are licensed under copyright "2020 Gram <gram@orsinium.dev>".
+ Both copyrights are included in releases of the fork since it contains changes from both parties.
The fork was created to provide source code, distributions, and maintenance for the project.
Raw data
{
"_id": null,
"home_page": "https://github.com/orsinium-labs/flake8-todos",
"name": "flake8-todos",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "flake8 flake8-plugin linter styleguide code quality",
"author": "Gram",
"author_email": "gram@orsinium.dev",
"download_url": "https://files.pythonhosted.org/packages/88/69/e4ecde7f50c3c874046f03dc7bda67d7be8e7cc28380f3f44c07456b45ad/flake8_todos-0.3.1.tar.gz",
"platform": null,
"description": "# flake8-todos\n\nPlugin for [flake8](http://flake8.pycqa.org/en/latest/) linter to check TODOs in the project.\n\nGood:\n\n```python\n# TODO(gram): check performance\n# https://github.com/orsinium-labs/flake8-todos/issues/1337\n```\n\nBad:\n\n```python\n# FIXME idk how it works lol\n```\n\nChecks:\n\n+ **T001**: use TODO instead of FIXME (or BUG) for consistency.\n+ **T002**: add author into TODO ([motivation](https://dave.cheney.net/practical-go/presentations/qcon-china.html#_dont_comment_bad_code_rewrite_it)).\n+ **T003**: add link on issue into TODO.\n+ **T004**: missed colon in TODO.\n+ **T005**: missed text in TODO.\n+ **T006**: write TODO instead of ToDo (use upper case).\n+ **T007**: missed space after colon in TODO.\n\n## Installation\n\n```bash\npython3 -m pip install --user flake8-todos\n```\n\n## Usage\n\nCheck that plugin was added in your flake8:\n\n```bash\n$ python3 -m flake8 --version\n3.7.7 (flake8-todos: 1.0.0, mccabe: 0.6.1, pycodestyle: 2.5.0, pyflakes: 2.1.1) CPython 3.6.7 on Linux\n```\n\nIf you don't see `flake8-todos` in the previous command output, check that `flake8` and `flake8-todos` is installed in the same interpreter.\n\nIf everything is OK, run `flake8`:\n\n```bash\npython -m flake8 example.py\n```\n\n## License\n\n+ The content of this repository contains a public fork of flake8-todos developed by [EclecticIQ B.V.](https://github.com/eclecticiq). Release 0.1.2 of the package was licensed under BSD 3-Clause License. File [LICENSE](LICENSE) contains the original license file.\n+ The fork is distributed under the same license and conditions.\n+ Release 0.1.2, all earlier releases, and corresponding source code are licensed under copyright \"2019 EclecticIQ\".\n+ All the later changes and distributions starting from 0.1.4 inclusively are licensed under copyright \"2020 Gram <gram@orsinium.dev>\".\n+ Both copyrights are included in releases of the fork since it contains changes from both parties.\n\nThe fork was created to provide source code, distributions, and maintenance for the project.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "Python linter to check TODO comments for consistency and best practice.",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/orsinium-labs/flake8-todos"
},
"split_keywords": [
"flake8",
"flake8-plugin",
"linter",
"styleguide",
"code",
"quality"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ba8e805907f920d171eda033ac825d23595072a1c04dd716106c8bc8ec9eec9e",
"md5": "3137b962b827ff0b5ccfe324ebef86f5",
"sha256": "0b4faca80bec49be7bf8e5dd46eec12f619e09cecac8a84a87775272300222b2"
},
"downloads": -1,
"filename": "flake8_todos-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3137b962b827ff0b5ccfe324ebef86f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7358,
"upload_time": "2024-02-09T08:50:43",
"upload_time_iso_8601": "2024-02-09T08:50:43.660031Z",
"url": "https://files.pythonhosted.org/packages/ba/8e/805907f920d171eda033ac825d23595072a1c04dd716106c8bc8ec9eec9e/flake8_todos-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8869e4ecde7f50c3c874046f03dc7bda67d7be8e7cc28380f3f44c07456b45ad",
"md5": "a313089b1c87853fec391382260afdb4",
"sha256": "942101a08f831d7d9f7d864d86169f3bcfaf8b6d56a004c0280eb51725266b16"
},
"downloads": -1,
"filename": "flake8_todos-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "a313089b1c87853fec391382260afdb4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7851,
"upload_time": "2024-02-09T08:50:45",
"upload_time_iso_8601": "2024-02-09T08:50:45.907276Z",
"url": "https://files.pythonhosted.org/packages/88/69/e4ecde7f50c3c874046f03dc7bda67d7be8e7cc28380f3f44c07456b45ad/flake8_todos-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-09 08:50:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "orsinium-labs",
"github_project": "flake8-todos",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "flake8-todos"
}
JSON
