reminder-aggregator 0.1.0__tar.gz

reminder_aggregator-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.3
+Name: reminder-aggregator
+Version: 0.1.0
+Summary: A simple cli application that aggregates codereminder tags like TODO, etc. in a report
+Requires-Dist: click>=8.3.0
+Requires-Dist: pathspec==0.12.1
+Requires-Dist: pip==25.2
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# Reminder Aggregator
+
+A simple python tool that scans files in a directory for common reminder tags such as `TODO`, `FIXME`, etc. and generates a report from them.
+
+## Requirements
+
+- Python 3.13+
+
+## Installation
+
+With [uv](https://docs.astral.sh/uv/getting-started/installation/) (recommended):
+
+```bash
+uv sync
+```
+
+## Usage
+
+```bash
+reminder_aggregator --help
+```
+
+## Future Changes
+
+- Filter to check whether a reminder-tag is inside a comment (currently causes false positives)
+- Support for multiple output formats
+
+## License
+
+GNU General Public License v3.0 or later
+
+See [LICENSE](./LICENSE) to see the full text.

reminder_aggregator-0.1.0/README.md

@@ -0,0 +1,32 @@
+# Reminder Aggregator
+
+A simple python tool that scans files in a directory for common reminder tags such as `TODO`, `FIXME`, etc. and generates a report from them.
+
+## Requirements
+
+- Python 3.13+
+
+## Installation
+
+With [uv](https://docs.astral.sh/uv/getting-started/installation/) (recommended):
+
+```bash
+uv sync
+```
+
+## Usage
+
+```bash
+reminder_aggregator --help
+```
+
+## Future Changes
+
+- Filter to check whether a reminder-tag is inside a comment (currently causes false positives)
+- Support for multiple output formats
+
+## License
+
+GNU General Public License v3.0 or later
+
+See [LICENSE](./LICENSE) to see the full text.

reminder_aggregator-0.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "reminder-aggregator"
+version = "0.1.0"
+description = "A simple cli application that aggregates codereminder tags like TODO, etc. in a report"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "click>=8.3.0",
+    "pathspec==0.12.1",
+    "pip==25.2",
+]
+
+[project.scripts]
+reminder-aggregator = "reminder_aggregator.cli:cli"
+
+[build-system]
+requires = ["uv_build>=0.9.2,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+line-length = 120
+indent-width = 4
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"
+
+[tool.ruff.lint]
+select = [
+    "F",   # pyflakes
+    "E",   # pycodestyle
+    "I",   # isort
+    "ANN", # flake8 type annotations
+    "RUF", # ruff-specific rules
+]
+fixable = ["ALL"]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.14.0",
+]

reminder_aggregator-0.1.0/src/reminder_aggregator/__main__.py

@@ -0,0 +1,4 @@
+if __name__ == "__main__":
+    from reminder_aggregator.cli import cli
+
+    cli()

reminder_aggregator-0.1.0/src/reminder_aggregator/cli.py

@@ -0,0 +1,144 @@
+import json
+import os
+import pathlib
+import re
+from typing import Any, Counter
+
+import click
+import pathspec
+
+
+def _write_report(filename: str, data: list[dict[str, Any]]) -> None:
+    counter = Counter(match["type"].upper() for match in data)
+    summary = dict(counter)
+    summary["total"] = sum(counter.values())
+
+    report = {
+        "summary": summary,
+        "details": data,
+    }
+
+    with open(filename, "w", encoding="utf-8") as file:
+        json.dump(report, file, indent=2)
+
+
+def _parse_file(path: pathlib.Path, path_root: pathlib.Path, pattern: re.Pattern) -> list[dict[str, Any]]:
+    # FIXME: Ensure that only comments count to matches.
+    matches: list[dict[str, Any]] = []
+
+    try:
+        for line_number, line in enumerate(open(path)):
+            line = line.strip()
+
+            if match := re.search(pattern, line):
+                matches.append(
+                    {
+                        "type": match.group(1),
+                        "file": str(path.relative_to(path_root)),
+                        "line": line_number + 1,
+                        "pos": match.start(1),
+                        "content": line.strip(),
+                    }
+                )
+
+    except UnicodeDecodeError:
+        print(f"Error reading {path}")
+
+    return matches
+
+
+def _parse_directory(
+    directory: pathlib.Path,
+    path_root: pathlib.Path,
+    match_regex: re.Pattern,
+    ignore_spec: pathspec.PathSpec,
+) -> list[dict[str, Any]]:
+    matches: list[dict[str, Any]] = []
+
+    for path in directory.rglob("*"):
+        if not path.is_file():
+            continue
+
+        if ignore_spec.match_file(path):
+            continue
+
+        match = _parse_file(path, path_root, match_regex)
+
+        if len(match) == 0:
+            continue
+
+        matches.extend(match)
+
+    return matches
+
+
+def _load_ignore_spec(file_path: str) -> pathspec.PathSpec:
+    file = pathlib.Path(file_path)
+
+    if not file.is_file():
+        return pathspec.PathSpec.from_lines("gitwildmatch", [])
+
+    with open(file, "r", encoding="utf-8") as file:
+        return pathspec.PathSpec.from_lines("gitwildmatch", file)
+
+
+CONTEXT_SETTINGS = {"max_content_width": os.get_terminal_size().columns - 10}
+
+
+@click.group(context_settings=CONTEXT_SETTINGS)
+def cli() -> None:
+    pass
+
+
+@cli.command("report", short_help="Generate a report")
+@click.option(
+    "--out-file",
+    "-o",
+    default="report.json",
+    show_default=True,
+    type=click.Path(),
+    help=" Specify path where the report will be saved",
+)
+@click.option(
+    "--format",
+    "-f",
+    default="json",
+    show_default=True,
+    type=click.Choice(["json"]),
+    help="Specify the format of the generated report",
+)
+@click.option(
+    "--ignore-file",
+    default=".gitignore",
+    show_default=True,
+    type=click.Path(exists=True),
+    help="Specify ignore file to use",
+)
+@click.argument("path", envvar="RA_SEARCH_DIR", default=".", type=click.Path())
+def report(path: str, out_file: str, format: str, ignore_file: str) -> None:
+    """
+    \b
+    positional arguments:
+        PATH    Specify the path that will be scanned [default: .]
+    """
+    # TODO: Add support for multiple output formats (junitxml, json, etc.)
+
+    path_root: pathlib.Path = pathlib.Path("./")
+    search_directory: pathlib.Path = pathlib.Path(path)
+
+    output_path: str = out_file
+
+    re_match_str: str = r"(TODO|FIXME|HACK|OPTIMIZE|REVIEW)"
+    re_match: re.Pattern = re.compile(re_match_str)
+
+    matches: list[dict[str, Any]] = []
+
+    ignore_spec: pathspec.PathSpec = _load_ignore_spec(ignore_file)
+
+    matches = _parse_directory(search_directory, path_root, re_match, ignore_spec)
+
+    _write_report(output_path, matches)
+
+
+if __name__ == "__main__":
+    cli()