[](https://postimg.cc/75fCzv5D)
[](https://coveralls.io/github/Start-Out/todo-or-not?branch=dev/staging&kill_cache=1)
[](https://github.com/psf/black)
<!-- TOC start (generated with https://github.com/derlin/bitdowntoc) -->
- [Overview](#overview)
- [Example](#example)
- [Contributing](#contributing)
- [Help](#help)
- [Fun Promo Video](#fun-promo-video)
<!-- TOC end -->
## Overview
> TODO or not to do, that is the question
TODO Or Not (todoon) is, in essence, a simple tool that checks your project for TODOs and FIXMEs and lets you know where they are.
You can also integrate this tool into your GitHub workflow via actions, and automate generating issues from the discovered TODOs and
FIXMEs. These generated issues will include a link to the file in GitHub as well as the surrounding lines. [Check out the wiki](wiki/Commands-‐-todoon#issues) for
more details on the GitHub Issues integration!
[Try it out! (see on PyPi)](https://pypi.org/project/todo-or-not/)
```bash
pip install --upgrade todo-or-not
todoignore-util -pc .gitignore
todoignore-util -ut .git
todoon
```
## Example
Check out [this example code](blob/dev/staging/example.py) and
the [issues that it yielded](https://github.com/Start-Out/todo-or-not/issues?q=is%3Aissue+author%3Aapp%2Ftodo-or-not+label%3Aexample+)!
```py
###########################
# Example usage of # todoon
###########################
def an_unfinished_function():
# TODO Finish documenting todo-or-not
print("Hello, I'm not quite done, there's more to do!")
print("Look at all these things I have to do!")
a = 1 + 1
b = a * 2
print("Okay I'm done!")
def a_broken_function():
# This line might not show up in the generated issue because it's too far away
# from the line that triggered the issue.
# The search for pertinent lines will stop when it hits a line break or the
# maximum number of lines, set by PERTINENT_LINE_LIMIT
a = [
1, 1, 2, 3
]
b = sum(a)
c = b * len(a)
return c / 0 # FIXME I just don't know why this doesn't work!
# Notice that this line will be collected
# But this one won't, because there's some whitespace between it and the trigger!
def a_skipping_example():
# Since the line below has `# todoon` in it, the checker will give it a pass even though it has the magic words!
print("Sometimes you really have to write TODO or FIXME, like this!") # todoon
def a_very_pretty_example():
# TODO Titled Issue! | In this format, you can define a title and a body! Also labels like #example or #enhancement
print("Check this out!")
```
## Contributing
Please target `dev/contribute` with your fork, and please use the appropriate PR template!
## Help
[See the wiki!](wiki)
## Fun Promo Video
https://github.com/Start-Out/todo-or-not/assets/10158233/d2c860f6-efd8-4ca4-b5d6-fcabe0bae6ce
Raw data
{
"_id": null,
"home_page": "https://github.com/apps/todo-or-not",
"name": "todo-or-not",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "todo, github",
"author": "TrentonYo",
"author_email": "trentonyo@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/76/bf/28c3ef13061d906fa320d92546a6a331050c025a2946220b9850e3c8bc31/todo_or_not-0.10.15.tar.gz",
"platform": null,
"description": "[](https://postimg.cc/75fCzv5D)\n\n\n[](https://coveralls.io/github/Start-Out/todo-or-not?branch=dev/staging&kill_cache=1)\n\n[](https://github.com/psf/black)\n\n\n\n<!-- TOC start (generated with https://github.com/derlin/bitdowntoc) -->\n\n- [Overview](#overview)\n- [Example](#example)\n- [Contributing](#contributing)\n- [Help](#help)\n- [Fun Promo Video](#fun-promo-video)\n\n<!-- TOC end -->\n\n## Overview\n\n> TODO or not to do, that is the question\n\nTODO Or Not (todoon) is, in essence, a simple tool that checks your project for TODOs and FIXMEs and lets you know where they are. \n\nYou can also integrate this tool into your GitHub workflow via actions, and automate generating issues from the discovered TODOs and\nFIXMEs. These generated issues will include a link to the file in GitHub as well as the surrounding lines. [Check out the wiki](wiki/Commands-\u2010-todoon#issues) for \nmore details on the GitHub Issues integration!\n\n[Try it out! (see on PyPi)](https://pypi.org/project/todo-or-not/)\n\n```bash\npip install --upgrade todo-or-not\ntodoignore-util -pc .gitignore \ntodoignore-util -ut .git\ntodoon\n```\n\n## Example\n\nCheck out [this example code](blob/dev/staging/example.py) and\nthe [issues that it yielded](https://github.com/Start-Out/todo-or-not/issues?q=is%3Aissue+author%3Aapp%2Ftodo-or-not+label%3Aexample+)!\n\n```py\n###########################\n# Example usage of # todoon\n###########################\n\ndef an_unfinished_function():\n # TODO Finish documenting todo-or-not\n print(\"Hello, I'm not quite done, there's more to do!\")\n print(\"Look at all these things I have to do!\")\n a = 1 + 1\n b = a * 2\n print(\"Okay I'm done!\")\n\n\ndef a_broken_function():\n # This line might not show up in the generated issue because it's too far away\n # from the line that triggered the issue.\n # The search for pertinent lines will stop when it hits a line break or the\n # maximum number of lines, set by PERTINENT_LINE_LIMIT\n a = [\n 1, 1, 2, 3\n ]\n b = sum(a)\n c = b * len(a)\n return c / 0 # FIXME I just don't know why this doesn't work!\n # Notice that this line will be collected\n\n # But this one won't, because there's some whitespace between it and the trigger!\n\n\ndef a_skipping_example():\n # Since the line below has `# todoon` in it, the checker will give it a pass even though it has the magic words!\n print(\"Sometimes you really have to write TODO or FIXME, like this!\") # todoon\n\n\ndef a_very_pretty_example():\n # TODO Titled Issue! | In this format, you can define a title and a body! Also labels like #example or #enhancement\n print(\"Check this out!\")\n\n```\n\n## Contributing\n\nPlease target `dev/contribute` with your fork, and please use the appropriate PR template! \n\n## Help\n\n[See the wiki!](wiki)\n\n## Fun Promo Video\n\nhttps://github.com/Start-Out/todo-or-not/assets/10158233/d2c860f6-efd8-4ca4-b5d6-fcabe0bae6ce\n\n\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "todoon integrates the TODOs in your codebase with your GitHub repository",
"version": "0.10.15",
"project_urls": {
"Documentation": "https://github.com/Start-Out/todo-or-not/wiki",
"Homepage": "https://github.com/apps/todo-or-not",
"Repository": "https://github.com/Start-Out/todo-or-not"
},
"split_keywords": [
"todo",
" github"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "018557ffd3c6b8364248c2350c417af3ae3dbdeda4421814c223db9fed4b6110",
"md5": "85228c808ed9df8518c57cd4cbfdb302",
"sha256": "7ac2c55e5c50e27e23ef3d916f4219ae272a234f222afbf88e80307ec097f694"
},
"downloads": -1,
"filename": "todo_or_not-0.10.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85228c808ed9df8518c57cd4cbfdb302",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 27413,
"upload_time": "2024-05-06T07:13:06",
"upload_time_iso_8601": "2024-05-06T07:13:06.953786Z",
"url": "https://files.pythonhosted.org/packages/01/85/57ffd3c6b8364248c2350c417af3ae3dbdeda4421814c223db9fed4b6110/todo_or_not-0.10.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76bf28c3ef13061d906fa320d92546a6a331050c025a2946220b9850e3c8bc31",
"md5": "5c0ba85b6a4fd19cb2775edb87858138",
"sha256": "d894e07582a247f63718b907cabf1d87574bfe225d78d8a4e980150ab7ea8e79"
},
"downloads": -1,
"filename": "todo_or_not-0.10.15.tar.gz",
"has_sig": false,
"md5_digest": "5c0ba85b6a4fd19cb2775edb87858138",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 27778,
"upload_time": "2024-05-06T07:13:08",
"upload_time_iso_8601": "2024-05-06T07:13:08.780217Z",
"url": "https://files.pythonhosted.org/packages/76/bf/28c3ef13061d906fa320d92546a6a331050c025a2946220b9850e3c8bc31/todo_or_not-0.10.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 07:13:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "apps",
"github_project": "todo-or-not",
"github_not_found": true,
"lcname": "todo-or-not"
}
JSON
