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.0.tar.gz (30.5 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.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for reminder_aggregator-0.2.0.tar.gz
Algorithm Hash digest
SHA256 726a08d6faa8a0071aee77c34a865f4a18ff349053a8edab2825f6873689cc56
MD5 8e3f6719a0f812462d1fd322037cd2d9
BLAKE2b-256 cbf8fa078e3bed3da998555bd584c1e743888d6c5e6d20cb5446f1716fe50f1b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for reminder_aggregator-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 56f148679257697440ff8f4658ceaffcd1d825e40c0eb2fbde1d1421a9671084
MD5 8827ba43920645551b7ed5e21ee12222
BLAKE2b-256 5adba2418a7e39444f93d4370d648c8abdcd4a92f201a32d3fea947b9ca30962

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