devtidy 0.1.0__tar.gz → 0.2.0__tar.gz

{devtidy-0.1.0/src/devtidy.egg-info → devtidy-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devtidy
-Version: 0.1.0
+Version: 0.2.0
 Summary: Safely find and reclaim stale developer build artifacts and environments.
 Author: Harish
 License-Expression: MIT
@@ -22,6 +22,8 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: rich>=13.9
+Requires-Dist: rich-argparse>=1.7
 Dynamic: license-file
 
 # DevTidy
@@ -43,6 +45,7 @@ easy, but removing data should require an explicit decision.
 - Can archive files with a manifest and restore them later.
 - Produces machine-readable JSON for scripts and CI.
 - Stores cleanup history locally. No telemetry or network calls.
+- Presents scans with a colorful terminal dashboard and animated progress.
 
 ## Install
 
@@ -76,6 +79,9 @@ devtidy restore --latest
 
 # JSON output for automation
 devtidy scan . --json
+
+# Disable styling for basic terminals
+devtidy scan . --no-color
 ```
 
 ## Commands

{devtidy-0.1.0 → devtidy-0.2.0}/README.md

@@ -17,6 +17,7 @@ easy, but removing data should require an explicit decision.
 - Can archive files with a manifest and restore them later.
 - Produces machine-readable JSON for scripts and CI.
 - Stores cleanup history locally. No telemetry or network calls.
+- Presents scans with a colorful terminal dashboard and animated progress.
 
 ## Install
 
@@ -50,6 +51,9 @@ devtidy restore --latest
 
 # JSON output for automation
 devtidy scan . --json
+
+# Disable styling for basic terminals
+devtidy scan . --no-color
 ```
 
 ## Commands

{devtidy-0.1.0 → devtidy-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "devtidy"
-version = "0.1.0"
+version = "0.2.0"
 description = "Safely find and reclaim stale developer build artifacts and environments."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -13,6 +13,10 @@ authors = [
   { name = "Harish" }
 ]
 keywords = ["cleanup", "developer-tools", "disk-space", "node-modules", "virtualenv"]
+dependencies = [
+  "rich>=13.9",
+  "rich-argparse>=1.7",
+]
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Environment :: Console",

{devtidy-0.1.0 → devtidy-0.2.0}/src/devtidy/__init__.py

@@ -1,4 +1,3 @@
 """DevTidy public package interface."""
 
-__version__ = "0.1.0"
-
+__version__ = "0.2.0"

{devtidy-0.1.0 → devtidy-0.2.0}/src/devtidy/cli.py

@@ -6,12 +6,22 @@ import sys
 from datetime import datetime
 from pathlib import Path
 
+from rich_argparse import RichHelpFormatter
+
 from devtidy import __version__
 from devtidy.models import Candidate
 from devtidy.rules import RULES
 from devtidy.safety import UnsafePathError
 from devtidy.scanner import scan
 from devtidy.storage import archive, delete, read_history, restore
+from devtidy.ui import (
+    make_console,
+    render_action_result,
+    render_candidates,
+    render_error,
+    render_header,
+    scan_status,
+)
 from devtidy.units import human_size, parse_duration, parse_size
 
 
@@ -42,20 +52,35 @@ def _add_scan_arguments(parser: argparse.ArgumentParser) -> None:
     parser.add_argument("--exclude", action="append", default=[], metavar="GLOB")
     parser.add_argument("--max-depth", type=int)
     parser.add_argument("--json", action="store_true")
+    parser.add_argument(
+        "--no-color",
+        action="store_true",
+        help="disable colors and terminal styling",
+    )
 
 
 def build_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         prog="devtidy",
         description="Safely reclaim stale developer artifacts.",
+        epilog="Scan first. Archive when unsure. Delete only when you mean it.",
+        formatter_class=RichHelpFormatter,
     )
     parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
     subparsers = parser.add_subparsers(dest="command")
 
-    scan_parser = subparsers.add_parser("scan", help="find cleanup candidates")
+    scan_parser = subparsers.add_parser(
+        "scan",
+        help="find cleanup candidates",
+        formatter_class=RichHelpFormatter,
+    )
     _add_scan_arguments(scan_parser)
 
-    clean_parser = subparsers.add_parser("clean", help="archive or delete candidates")
+    clean_parser = subparsers.add_parser(
+        "clean",
+        help="archive or delete candidates",
+        formatter_class=RichHelpFormatter,
+    )
     _add_scan_arguments(clean_parser)
     action = clean_parser.add_mutually_exclusive_group(required=True)
     action.add_argument("--archive", action="store_true")
@@ -66,18 +91,33 @@ def build_parser() -> argparse.ArgumentParser:
         help="confirm the selected cleanup action",
     )
 
-    restore_parser = subparsers.add_parser("restore", help="restore an archive session")
+    restore_parser = subparsers.add_parser(
+        "restore",
+        help="restore an archive session",
+        formatter_class=RichHelpFormatter,
+    )
     restore_parser.add_argument("session_id", nargs="?")
     restore_parser.add_argument("--latest", action="store_true")
     restore_parser.add_argument("--overwrite", action="store_true")
     restore_parser.add_argument("--json", action="store_true")
+    restore_parser.add_argument("--no-color", action="store_true")
 
-    history_parser = subparsers.add_parser("history", help="show local cleanup history")
+    history_parser = subparsers.add_parser(
+        "history",
+        help="show local cleanup history",
+        formatter_class=RichHelpFormatter,
+    )
     history_parser.add_argument("--limit", type=int, default=10)
     history_parser.add_argument("--json", action="store_true")
+    history_parser.add_argument("--no-color", action="store_true")
 
-    rules_parser = subparsers.add_parser("rules", help="explain built-in matching rules")
+    rules_parser = subparsers.add_parser(
+        "rules",
+        help="explain built-in matching rules",
+        formatter_class=RichHelpFormatter,
+    )
     rules_parser.add_argument("--json", action="store_true")
+    rules_parser.add_argument("--no-color", action="store_true")
     return parser
 
 
@@ -92,48 +132,64 @@ def _candidates(args: argparse.Namespace) -> list[Candidate]:
     )
 
 
-def _print_candidates(candidates: list[Candidate]) -> None:
-    if not candidates:
-        print("No cleanup candidates found.")
-        return
-    for candidate in candidates:
-        activity = datetime.fromtimestamp(candidate.last_activity).strftime("%Y-%m-%d")
-        print(
-            f"{human_size(candidate.size):>10}  "
-            f"{candidate.category:<7}  {activity}  {candidate.path}"
-        )
-    print(f"\nPotential savings: {human_size(sum(item.size for item in candidates))}")
-
-
 def _scan_command(args: argparse.Namespace) -> int:
-    candidates = _candidates(args)
     if args.json:
+        candidates = _candidates(args)
         print(json.dumps([item.to_dict() for item in candidates], indent=2))
     else:
-        _print_candidates(candidates)
+        console = make_console(no_color=args.no_color)
+        roots = args.paths or [Path.cwd()]
+        render_header(
+            console,
+            "Workspace scan",
+            "Finding generated artifacts that can be rebuilt when needed.",
+        )
+        with scan_status(console, roots, enabled=console.is_terminal):
+            candidates = _candidates(args)
+        render_candidates(console, candidates)
     return 0
 
 
 def _clean_command(args: argparse.Namespace) -> int:
-    candidates = _candidates(args)
+    if args.json:
+        candidates = _candidates(args)
+    else:
+        console = make_console(no_color=args.no_color)
+        render_header(
+            console,
+            "Cleanup preview",
+            "Nothing changes until the requested safety checks pass.",
+        )
+        roots = args.paths or [Path.cwd()]
+        with scan_status(console, roots, enabled=console.is_terminal):
+            candidates = _candidates(args)
     if not candidates:
-        print("No cleanup candidates found.")
+        if args.json:
+            print("[]")
+        else:
+            render_candidates(console, [])
         return 0
     if not args.yes:
-        _print_candidates(candidates)
+        if args.json:
+            print(json.dumps([item.to_dict() for item in candidates], indent=2))
+        else:
+            render_candidates(console, candidates)
         action = "archive" if args.archive else "permanently delete"
-        print(f"\nRefusing to {action} without --yes.", file=sys.stderr)
+        error_console = make_console(no_color=args.no_color, stderr=True)
+        render_error(error_console, f"Refusing to {action} without --yes.")
         return 2
 
     result = archive(candidates) if args.archive else delete(candidates)
     if args.json:
         print(json.dumps(result, indent=2))
     else:
-        print(
-            f"{result['action'].capitalize()} complete: "
-            f"{len(candidates)} item(s), {human_size(int(result['total_size']))}."
+        render_action_result(
+            console,
+            action=str(result["action"]),
+            count=len(candidates),
+            total_size=int(result["total_size"]),
+            session_id=str(result["session_id"]),
         )
-        print(f"Session: {result['session_id']}")
     return 0
 
 
@@ -142,7 +198,15 @@ def _restore_command(args: argparse.Namespace) -> int:
     if args.json:
         print(json.dumps(result, indent=2))
     else:
-        print(f"Restored {len(result['items'])} item(s) from {result['session_id']}.")
+        console = make_console(no_color=args.no_color)
+        render_header(console, "Archive restored", "Your generated artifacts are back in place.")
+        render_action_result(
+            console,
+            action="restore",
+            count=len(result["items"]),
+            total_size=int(result["total_size"]),
+            session_id=str(result["session_id"]),
+        )
     return 0
 
 
@@ -152,13 +216,19 @@ def _history_command(args: argparse.Namespace) -> int:
         print(json.dumps(records, indent=2))
         return 0
     if not records:
-        print("No cleanup history found.")
+        console = make_console(no_color=args.no_color)
+        render_header(console, "Cleanup history", "Local-only records of DevTidy actions.")
+        console.print("[dim]No cleanup history found.[/]")
         return 0
+    console = make_console(no_color=args.no_color)
+    render_header(console, "Cleanup history", "Local-only records of DevTidy actions.")
     for record in records:
         created = datetime.fromtimestamp(record["created_at"]).strftime("%Y-%m-%d %H:%M")
-        print(
-            f"{created}  {record['action']:<7}  "
-            f"{human_size(int(record['total_size'])):>10}  {record['session_id']}"
+        console.print(
+            f"[dim]{created}[/]  "
+            f"[bold]{record['action']:<7}[/]  "
+            f"[green]{human_size(int(record['total_size'])):>10}[/]  "
+            f"[dim]{record['session_id']}[/]"
         )
     return 0
 
@@ -176,10 +246,14 @@ def _rules_command(args: argparse.Namespace) -> int:
     if args.json:
         print(json.dumps(rules, indent=2))
     else:
+        console = make_console(no_color=args.no_color)
+        render_header(console, "Cleanup rules", "Every match is explainable and project-aware.")
         for rule in rules:
             names = ", ".join(rule["directories"])
-            print(f"{rule['name']} ({rule['category']}): {names}")
-            print(f"  {rule['description']}")
+            console.print(
+                f"[bold cyan]{rule['name']}[/] [dim]({rule['category']})[/]  {names}"
+            )
+            console.print(f"  [dim]{rule['description']}[/]")
     return 0
 
 
@@ -207,6 +281,6 @@ def main(argv: list[str] | None = None) -> int:
         parser.print_help()
         return 0
     except (UnsafePathError, ValueError, FileExistsError, PermissionError) as error:
-        print(f"devtidy: error: {error}", file=sys.stderr)
+        no_color = bool(getattr(args, "no_color", False))
+        render_error(make_console(no_color=no_color, stderr=True), str(error))
         return 1
-

devtidy-0.2.0/src/devtidy/ui.py

@@ -0,0 +1,163 @@
+from __future__ import annotations
+
+from contextlib import nullcontext
+from datetime import datetime
+from pathlib import Path
+from typing import ContextManager, Iterable
+
+from rich import box
+from rich.console import Console, Group
+from rich.panel import Panel
+from rich.table import Table
+from rich.text import Text
+
+from devtidy import __version__
+from devtidy.models import Candidate
+from devtidy.units import human_size
+
+
+ACCENT = "rgb(190,145,255)"
+CYAN = "rgb(100,210,255)"
+GREEN = "rgb(120,220,160)"
+MUTED = "grey62"
+WARNING = "rgb(255,190,100)"
+CATEGORY_STYLES = {
+    "node": "rgb(120,220,160)",
+    "python": "rgb(100,180,255)",
+    "cache": "rgb(190,145,255)",
+    "build": "rgb(255,190,100)",
+}
+
+
+def make_console(*, no_color: bool = False, stderr: bool = False) -> Console:
+    return Console(
+        stderr=stderr,
+        no_color=no_color,
+        highlight=False,
+        soft_wrap=False,
+    )
+
+
+def render_header(console: Console, title: str, subtitle: str) -> None:
+    brand = Text()
+    brand.append("dev", style=f"bold {ACCENT}")
+    brand.append("tidy", style=f"bold {CYAN}")
+    brand.append(f"  v{__version__}", style=MUTED)
+
+    heading = Text(title, style="bold white")
+    detail = Text(subtitle, style=MUTED)
+    console.print(
+        Panel(
+            Group(brand, Text(""), heading, detail),
+            border_style=ACCENT,
+            box=box.ROUNDED,
+            padding=(0, 1),
+        )
+    )
+
+
+def scan_status(console: Console, roots: Iterable[Path], enabled: bool) -> ContextManager:
+    if not enabled:
+        return nullcontext()
+    root_count = len(list(roots))
+    label = "workspace" if root_count == 1 else f"{root_count} workspaces"
+    return console.status(
+        f"[bold {CYAN}]Scanning {label}[/] [dim]for reclaimable artifacts...[/]",
+        spinner="dots12",
+        spinner_style=ACCENT,
+    )
+
+
+def render_candidates(console: Console, candidates: list[Candidate]) -> None:
+    if not candidates:
+        console.print(
+            Panel(
+                "[bold green]All tidy.[/] No cleanup candidates matched your filters.",
+                border_style=GREEN,
+                box=box.ROUNDED,
+            )
+        )
+        return
+
+    table = Table(
+        box=box.SIMPLE_HEAVY,
+        border_style="grey35",
+        header_style="bold grey85",
+        padding=(0, 1),
+        expand=True,
+    )
+    table.add_column("SIZE", justify="right", no_wrap=True, style="bold white")
+    table.add_column("TYPE", no_wrap=True)
+    table.add_column("LAST ACTIVE", no_wrap=True, style=MUTED)
+    table.add_column("PATH", ratio=1, overflow="fold")
+
+    for candidate in candidates:
+        activity = datetime.fromtimestamp(candidate.last_activity).strftime("%Y-%m-%d")
+        category_style = CATEGORY_STYLES.get(candidate.category, "white")
+        category = Text(f" {candidate.category.upper()} ", style=f"bold black on {category_style}")
+        path = Text(str(candidate.path), style="grey85")
+        path.stylize(f"bold {CYAN}", max(0, len(path) - len(candidate.path.name)))
+        table.add_row(human_size(candidate.size), category, activity, path)
+
+    total = sum(item.size for item in candidates)
+    by_category: dict[str, int] = {}
+    for candidate in candidates:
+        by_category[candidate.category] = by_category.get(candidate.category, 0) + candidate.size
+
+    summary = Text()
+    summary.append("Found ", style=MUTED)
+    summary.append(str(len(candidates)), style="bold white")
+    summary.append(" candidates  ", style=MUTED)
+    summary.append("Potential savings ", style=MUTED)
+    summary.append(human_size(total), style=f"bold {GREEN}")
+    if by_category:
+        summary.append("\n")
+        summary.append(
+            "  ".join(
+                f"{category}: {human_size(size)}"
+                for category, size in sorted(by_category.items(), key=lambda item: -item[1])
+            ),
+            style=MUTED,
+        )
+
+    console.print(table)
+    console.print(
+        Panel(summary, border_style=GREEN, box=box.ROUNDED, padding=(0, 1))
+    )
+    console.print(
+        f"[{MUTED}]Next:[/] [bold]devtidy clean <path> --archive --yes[/] "
+        f"[{MUTED}]to reclaim space safely.[/]"
+    )
+
+
+def render_action_result(
+    console: Console,
+    *,
+    action: str,
+    count: int,
+    total_size: int,
+    session_id: str,
+) -> None:
+    verbs = {
+        "archive": "Archived",
+        "delete": "Deleted",
+        "restore": "Restored",
+    }
+    verb = verbs.get(action, action.capitalize())
+    message = Text()
+    message.append(f"{verb} {count} item(s)", style="bold white")
+    message.append(" and reclaimed ", style=MUTED)
+    message.append(human_size(total_size), style=f"bold {GREEN}")
+    message.append(f"\nSession  {session_id}", style=MUTED)
+    console.print(Panel(message, title="[bold green]Complete[/]", border_style=GREEN, box=box.ROUNDED))
+
+
+def render_error(console: Console, message: str) -> None:
+    console.print(
+        Panel(
+            Text(message, style="bold white"),
+            title=f"[bold {WARNING}]DevTidy stopped[/]",
+            border_style=WARNING,
+            box=box.ROUNDED,
+        )
+    )

{devtidy-0.1.0 → devtidy-0.2.0/src/devtidy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devtidy
-Version: 0.1.0
+Version: 0.2.0
 Summary: Safely find and reclaim stale developer build artifacts and environments.
 Author: Harish
 License-Expression: MIT
@@ -22,6 +22,8 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: rich>=13.9
+Requires-Dist: rich-argparse>=1.7
 Dynamic: license-file
 
 # DevTidy
@@ -43,6 +45,7 @@ easy, but removing data should require an explicit decision.
 - Can archive files with a manifest and restore them later.
 - Produces machine-readable JSON for scripts and CI.
 - Stores cleanup history locally. No telemetry or network calls.
+- Presents scans with a colorful terminal dashboard and animated progress.
 
 ## Install
 
@@ -76,6 +79,9 @@ devtidy restore --latest
 
 # JSON output for automation
 devtidy scan . --json
+
+# Disable styling for basic terminals
+devtidy scan . --no-color
 ```
 
 ## Commands

{devtidy-0.1.0 → devtidy-0.2.0}/src/devtidy.egg-info/SOURCES.txt

@@ -9,12 +9,15 @@ src/devtidy/rules.py
 src/devtidy/safety.py
 src/devtidy/scanner.py
 src/devtidy/storage.py
+src/devtidy/ui.py
 src/devtidy/units.py
 src/devtidy.egg-info/PKG-INFO
 src/devtidy.egg-info/SOURCES.txt
 src/devtidy.egg-info/dependency_links.txt
 src/devtidy.egg-info/entry_points.txt
+src/devtidy.egg-info/requires.txt
 src/devtidy.egg-info/top_level.txt
+tests/test_cli.py
 tests/test_scanner.py
 tests/test_storage.py
 tests/test_units.py

devtidy-0.2.0/src/devtidy.egg-info/requires.txt

@@ -0,0 +1,2 @@
+rich>=13.9
+rich-argparse>=1.7

devtidy-0.2.0/tests/test_cli.py

@@ -0,0 +1,50 @@
+import json
+import tempfile
+import unittest
+from contextlib import redirect_stdout
+from io import StringIO
+from pathlib import Path
+
+from devtidy.cli import main
+from devtidy.models import Candidate
+from devtidy.ui import make_console, render_candidates
+
+
+class CliTests(unittest.TestCase):
+    def test_json_output_has_no_terminal_markup(self):
+        with tempfile.TemporaryDirectory() as temporary:
+            root = Path(temporary)
+            cache = root / "__pycache__"
+            cache.mkdir()
+            (cache / "module.pyc").write_bytes(b"cache")
+            output = StringIO()
+
+            with redirect_stdout(output):
+                exit_code = main(["scan", str(root), "--json"])
+
+            payload = json.loads(output.getvalue())
+            self.assertEqual(exit_code, 0)
+            self.assertEqual(payload[0]["category"], "cache")
+
+    def test_no_color_candidate_output(self):
+        output = StringIO()
+        console = make_console(no_color=True)
+        console.file = output
+        candidate = Candidate(
+            path=Path("project/node_modules"),
+            root=Path("project"),
+            rule="node_modules",
+            category="node",
+            size=1024,
+            last_activity=0,
+        )
+
+        render_candidates(console, [candidate])
+
+        rendered = output.getvalue()
+        self.assertIn("Potential savings", rendered)
+        self.assertNotIn("\x1b[", rendered)
+
+
+if __name__ == "__main__":
+    unittest.main()