Skip to main content

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

Project description

Reminder Aggregator

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

PyPI - Version PyPI - Python Version pre-commit

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 -it -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

License

GNU General Public License v3.0 or later

See LICENSE to see the full text.

Project details


Download files

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

Source Distribution

reminder_aggregator-0.2.1.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reminder_aggregator-0.2.1-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file reminder_aggregator-0.2.1.tar.gz.

File metadata

  • Download URL: reminder_aggregator-0.2.1.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.3

File hashes

Hashes for reminder_aggregator-0.2.1.tar.gz
Algorithm Hash digest
SHA256 2ac6034dc5b92cda84ec0d3d526ee4eaf70ea617d419ea857e86aef04d42521e
MD5 2085eb8852b56b60b8e3d9e260d2a024
BLAKE2b-256 0207c9e9ee2e929b7a9f14071996f29cca57b42970988768c704962549cd996c

See more details on using hashes here.

File details

Details for the file reminder_aggregator-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for reminder_aggregator-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 955e2fce3d692af2ced7dd6dcf40bd638c4bf5b61da1c5e356d773a4c00c3827
MD5 4908fc5380056a8557f40ced225b8943
BLAKE2b-256 bda6434b93a4ec40f16a749e15e8e65ab17498901a6aa15b68fde360e58f5499

See more details on using hashes here.

Supported by

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