Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paulpls/todo
Drop-in utility for automatically generating project to-do lists
https://github.com/paulpls/todo
automation python-utility qol utility
Last synced: 27 days ago
JSON representation
Drop-in utility for automatically generating project to-do lists
- Host: GitHub
- URL: https://github.com/paulpls/todo
- Owner: paulpls
- License: other
- Created: 2023-05-27T06:08:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-24T02:17:06.000Z (7 months ago)
- Last Synced: 2024-06-24T03:24:10.715Z (7 months ago)
- Topics: automation, python-utility, qol, utility
- Language: Python
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# To-Do List Automator
Author: [paulpls](https://github.com/paulpls)
License: [FSF](LICENSE.md)
## About
Use this utility to automatically generate a to-do list by searching for patterns in the provided file paths. In return, you'll get a nicely formatted markdown file with direct links to your code, enabling you to pick up right where you left off.
## Dependencies
- python >= 3.6
- GNU `grep`
- GNU `rm`
## Instructions
- Copy `todo.py` to your project's top-level directory (or elsewhere if you're feeling brave)
- Edit the file to customize the output:
* [files](todo.py#L40): List of file or directory paths to search (allows `*` globs)
* [patterns](todo.py#L44): List of search keyords
* [header](todo.py#L49): Output file header
* [outpath](todo.py#L50): Output file path
- Run the program: `python todo.py`
## Example
Given the file `example.py`:
```py
01 def do_something():
02 # TODO make this do some stuff
03 ...
```
With `TODO` included in the search terms, the output file will look something like this:
```markdown
# Todo List
### TODO
- [example.py](example.py#L2) make this do some stuff
...
```
## Wontfix
- Currently only outputs a single line matching each pattern. Additional functionality to include entire multiline commments is not planned at this time.