Skip to main content

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

  1. Finds an unreported TODO,

  2. Commits the reported TODO to the git repo

  3. Reports it to the GitHub as an issue,

  4. 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

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Delator-0.1-py3.9.egg (1.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page