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.1.4.tar.gz (30.3 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.1.4-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for reminder_aggregator-0.1.4.tar.gz
Algorithm Hash digest
SHA256 4ed8956ce0027482450d1de6d957c7bd5829df540e4d15c87da7093fe278baa0
MD5 1f71893f4edfa0afa5c2d429c0a34be4
BLAKE2b-256 dcd2377dc6ec566fee70c7cb81871b6d59a48c3319802d8f2a63a9f3af8f726c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for reminder_aggregator-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 dbd1e150b4ac10118171aa403af29b8d40842915e1845a6637abaf575ea9c27b
MD5 ed2271cee8130ba383363d4e425dad18
BLAKE2b-256 1b0117157ffd452db021fc13b95e9638ca1727ed0c33564e1778a37394ef46d3

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