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

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.3.tar.gz (29.9 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.3-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for reminder_aggregator-0.1.3.tar.gz
Algorithm Hash digest
SHA256 0ee356357ee85b42c553a93ea1248a32e254aff07f3be091c79d660236213d13
MD5 a0aad59b396bd872d82b407adb6d950e
BLAKE2b-256 527d5216f1b007b4eb1ca5a4a55e1903046d352928f6bcecf3f3fd66d960206f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for reminder_aggregator-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 14aa4d1befac10077225210159ed629d90db728a797f321a85dc82227ab94c45
MD5 d61075ba62307d541085e7e57f6c64bf
BLAKE2b-256 f4f72819bdadab51713a4806994f4a7896f511d35f65910ea630ee9720fa54e2

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