Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mannasoumya/todo-parser
Simple TODO parser written in Python
https://github.com/mannasoumya/todo-parser
command-line command-line-tool github github-actions github-api github-issues issue-management issue-tracker issues parser python python3 todo todoparser utilities utility
Last synced: about 1 month ago
JSON representation
Simple TODO parser written in Python
- Host: GitHub
- URL: https://github.com/mannasoumya/todo-parser
- Owner: mannasoumya
- License: mit
- Created: 2022-06-22T08:38:00.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T10:02:00.000Z (5 months ago)
- Last Synced: 2024-07-25T11:31:14.477Z (5 months ago)
- Topics: command-line, command-line-tool, github, github-actions, github-api, github-issues, issue-management, issue-tracker, issues, parser, python, python3, todo, todoparser, utilities, utility
- Language: Python
- Homepage:
- Size: 44.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# todo-parser
Simple TODO parser written in Python.
Report **TODOS** as **ISSUES** in Github.
### Priorities in TODOs
The more number of ending characters in the **keyword**, the more priority.
Consider following example sorted accordingly:
- TODOOO: Highest priority
- TODOO: Less priority
- TODO: Lowest priority
Here, number of '**O**'s determine the priority of each item.
### Auto Parsing Comment Identifier
Supported for the following languages:
**Python, Bash, Java, C, C++, R, Perl, Elixir, Erlang, Javascript, Typescript, PHP, C#, Rust, Golang, Kotlin, Haskell**
### Github Issue Reporting
Pass the **-gh** flag in the program to enable ***Github Issue Reporting***. The github credentials are picked up from ```creds.json``` in the current working directory. The file looks like following:
```json
{
"user" : ,
"repo" : ,
"auth_token" :
}
```
```pip -r requirements.txt``` will install **requests** library of Python which is needed to send request to github API.
Guide on creating your own **Access Token**: [link](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
### Quick Start
```console
$ python3 todo_parser.py -h
Usage: python ./todo_parser.py -i [OPTIONS]
OPTIONS:
-i (str) : Input file path
-c (str) : Comment Identifier (default: `//`)
(Auto-Comment-Identification Parser will be overridden if this flag is passed)
-k (str) : Keyword to be parsed (default: `TODO`)
-s (bool) : Save TODOs to file
-p (bool) : Enable/Disable Priority Mode (default: enabled)
-v (bool) : Enable/Disable Verbose Mode (default: disabled)
-gh (bool) : Report issues to Github (default: disabled)
-h (bool) : Print this help and exit
$ python3 todo_parser.py -i todo_parser.py
Line: 31 -> TODOOOOOO: This is a self referencing item; Highest priority
Line: 234 -> TODOOO: Take file name as input and save to that file name
Line: 50 -> TODOO: Another one
Line: 76 -> TODO: another one
Line: 237 -> TODO: Test todo and this is a continuation
```
### With priority disabled (pass `-p` flag)
```console
$ python3 todo_parser.py -i todo_parser.py -p
Line: 31 -> TODOOOOOO: This is a self referencing item; Highest priority
Line: 50 -> TODOO: Another one
Line: 76 -> TODO: another one
Line: 234 -> TODOOO: Take file name as input and save to that file name
Line: 237 -> TODO: Test todo and this is a continuation
```
### With verbose mode (pass ```-v``` flag)
```console
$ python3 todo_parser.py -i todo_parser.py -k 'FIXME' -v
Auto found comment identifier for file `todo_parser.py` : #
--------------------------------------
Keyword : FIXME
Comment Identifier : #
Priority Mode : enabled
Save To File : disabled
Report Issues to Github : disabled
--------------------------------------
File : todo_parser.py
Total Lines : 278
Total Blank Lines : 36
--------------------------------------
Line: 67 -> FIXMEEE : Highest Priority Fix
Line: 218 -> FIXMEE: Second priority fix
Line: 132 -> FIXME: Demo FixMe
```
### Github Issue Reporting (pass ```-gh``` flag)
```console
$ python3 todo_parser.py -i ./todo_parser.py -v -gh
Auto found comment identifier for file `./todo_parser.py` : #
----------------------------------------
Keyword : TODO
Comment Identifier : #
Priority Mode : enabled
Save To File : disabled
Report Issues to Github : enabled
----------------------------------------
File : ./todo_parser.py
Total Lines : 278
Total Blank Lines : 36
----------------------------------------
Line: 31 -> TODOOOOOO: This is a self referencing item; Highest priority
Line: 234 -> TODOOO: Take file name as input and save to that file name
Line: 50 -> TODOO: Another one
Line: 76 -> TODO: another one
Line: 237 -> TODO: Test todo and this is a continuation
--------------------
REPORTING TO GITHUB
--------------------
-----------------------------------------
Github User : mannasoumya
Github Repo : test-gh-api
-----------------------------------------
----------------------------
Title : `This is a self referencing item; Highest priority`
Body :
----------------------------
Do you want to report this todo ? (y/n/q) n
Not reporting this issue....
----------------------------
Title : `Another one`
Body :
----------------------------
Do you want to report this todo ? (y/n/q) n
Not reporting this issue....
----------------------------
Title : `another one`
Body :
----------------------------
Do you want to report this todo ? (y/n/q) n
Not reporting this issue....
----------------------------
Title : `Take file name as input`
Body : and save to that file name
----------------------------
Do you want to report this todo ? (y/n/q) y
Issue 9: `Take file name as input` created successfully
----------------------------
Title : `Test todo`
Body : and this is a continuation
----------------------------
Do you want to report this todo ? (y/n/q) y
Issue 10: `Test todo` created successfully
```