A simple tool that collects TODOS and reports them as GitHub issues.
Project description
# Snitch
A simple tool that collects TODOS and reports them as GitHub issues.
## How it works
Finds an unreported TODO,
Commits the reported TODO to the git repo
Reports it to the GitHub as an issue,
Repeats the process until all of the unreported TODOs are reported.
## TODO Parsing
### JS Example ` // TODO: Do something COOL // Create api for user // Create api for admin ` Regular experssion - `^(.*)TODO: .*(\n//(.*).*)*` - https://regex101.com/r/BWcBjl/1
### Python Example ` # TODO: Do something COOL # Create api for user # Create api for admin ` Regular experssion - `^(.*)TODO: .*(\n#(.*).*)*` - https://regex101.com/r/5uzV1Z/1
### Golang Example ` // TODO: Do something COOL // Create api for user // Create api for admin ` Regular experssion - `^(.*)TODO: .*(\n//(.*).*)*` - https://regex101.com/r/BWcBjl/1
## How to run it will automatically reference the origin remote as standart
Args:
- Required:
–token
- Not Required:
–ignore_files –ignore_directories
### First Example ` python main.py --token='your personal token from github' `
### Second Example ` python main.py --token='your personal token from github',--ignore_files=d.py,s.py --ignore_directories=secret `
### Third Example ` python main.py --token='your personal token from github',--ignore_directories=settings,data `
### Fourth Example ` python main.py --token='your personal token from github' --ignore_files=d.py,m.py,secret_data.py `
## How to install
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file Delator-0.1-py3.9.egg
.
File metadata
- Download URL: Delator-0.1-py3.9.egg
- Upload date:
- Size: 1.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0fc5ce16b9b5bd30a8154d6159ede15471508d2ff0f2bb7aabc482fb6339513b |
|
MD5 | 0905f768b97c4cff12d0abf8ae28522d |
|
BLAKE2b-256 | a2c52dfc7fb2bbb9d93bb1ea1e672096cf2d049814216e638ff4a7170286ab69 |