Reminder Aggregator

A simple Python tool that scans files for common reminder tags like TODO and FIXME to generate a report from them.

Requirements

• Python 3.10+

Installation

From PyPI (recommended):

pip install reminder-aggregator

From source with uv:

git clone https://github.com/NocDerEchte/reminder-aggregator.git
cd reminder-aggregator

uv sync
uv run reminder-aggregator --help

Usage

Scan current directory:

reminder-aggregator

Scan specific directory:

reminder-aggregator /path/to/directory

Specify output file:

reminder-aggregator --out-file /path/to/report.json

Show all available options:

reminder-aggregator --help

Docker Usage

Run the containerized version by mounting your project directory:

docker run --rm -v "$(pwd):/work" nocderechte/reminder-aggregator:latest

Roadmap

• Filter to check whether a reminder-tag is inside a comment (currently causes false positives)
• Support for multiple output formats
  • junitxml
  • raw/stdout
  • codeclimate

License

GNU General Public License v3.0 or later

See LICENSE to see the full text.