Metadata-Version: 2.1
Name: todofinder
Version: 1.1.0
Summary: Scan for TODO's
Home-page: https://github.com/jonathangjertsen/todofinder
Author: Jonathan Reichelt Gjertsen
Author-email: jonath.re@gmail.com
License: MIT
Project-URL: Documentation, https://github.com/jonathangjertsen/todofinder
Project-URL: Source, https://github.com/jonathangjertsen/todofinder
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Description-Content-Type: text/markdown

# TODO-finder

[![Build Status](https://travis-ci.com/jonathangjertsen/todofinder.svg?branch=master)](https://travis-ci.com/jonathangjertsen/todofinder)
[![codecov](https://codecov.io/gh/jonathangjertsen/todofinder/branch/master/graph/badge.svg)](https://codecov.io/gh/jonathangjertsen/todofinder)


It finds TODOs!

## Requirements

Python 3.8

To install, run `pip install todofinder`.

## Usage

Specify a glob pattern with `-g` and use `-o` to specify where to store the CSV report.

```
python -m todofinder -g <glob_pattern> ... <glob_pattern> -o FILE
```

### Plugins

You can use `-p` to enable language-specific parsers that will prevent false
positives and skip over lines without comments. Currently available plugins:

* Python: `-p py`
* C: `-p c`

You can have one or more active plugins (e.g. `-p py c`) or all at once (`-p all`)


