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.
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file reminder_aggregator-0.3.0.tar.gz.
File metadata
- Download URL: reminder_aggregator-0.3.0.tar.gz
- Upload date:
- Size: 31.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f1fa54e5e8a161aa1b832738ffe0998f0aee67016ccaae8896b4f3c239bf7423
|
|
| MD5 |
f4100be698e17adf4b0261be0605292d
|
|
| BLAKE2b-256 |
be62f5d944df4fba97b0b0023e88434be13d7ccf9c7e6431c9bb35bf10e2c615
|
File details
Details for the file reminder_aggregator-0.3.0-py3-none-any.whl.
File metadata
- Download URL: reminder_aggregator-0.3.0-py3-none-any.whl
- Upload date:
- Size: 17.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c9b2bf7430b38269290d6995fa2ef8eedd6f48c6eac55db3e91b646826a97adc
|
|
| MD5 |
6e1322f1eacec9ea5a18f186936782a0
|
|
| BLAKE2b-256 |
6fcb626d126838d7341da03ac462d7740f81c91b6f4428544021ba317826097d
|
