repodoctor-cli 1.0.0__py3-none-any.whl

repodoctor/spinner.py

@@ -0,0 +1,174 @@
+"""
+spinner.py — Zero-dependency terminal spinner / progress animation.
+
+Uses only Python stdlib: sys, threading, time, itertools.
+Automatically suppresses output when stdout is not a TTY
+(e.g. file redirection, CI pipelines).
+"""
+
+import sys
+import threading
+import time
+import itertools
+
+
+# Braille spinner frames — visually smooth, widely supported
+_SPINNER_FRAMES = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
+
+# ANSI colour codes (disabled when not TTY)
+_CYAN   = "\033[36m"
+_GREEN  = "\033[32m"
+_YELLOW = "\033[33m"
+_RESET  = "\033[0m"
+_BOLD   = "\033[1m"
+
+
+def _is_tty() -> bool:
+    """Return True only when stdout is an interactive terminal."""
+    return hasattr(sys.stdout, "isatty") and sys.stdout.isatty()
+
+
+class Spinner:
+    """
+    Context-manager / manual spinner that renders a live animation line.
+
+    Usage (context manager — recommended):
+        with Spinner("Scanning repository"):
+            do_work()
+
+    Usage (manual):
+        sp = Spinner("Cloning repo")
+        sp.start()
+        do_work()
+        sp.stop(success=True)
+    """
+
+    def __init__(self, message: str = "Working", colour: bool = True, silent: bool = False) -> None:
+        self._message = message
+        self._use_colour = colour and _is_tty()
+        self._active = False
+        self._thread: threading.Thread | None = None
+        self.silent = silent
+
+    # ------------------------------------------------------------------ #
+    # public API
+    # ------------------------------------------------------------------ #
+
+    def start(self) -> "Spinner":
+        if self.silent:
+            return self
+        if not _is_tty():
+            # Non-interactive: just print the static message
+            print(f"{self._message}…", flush=True)
+            return self
+        self._active = True
+        self._thread = threading.Thread(target=self._spin, daemon=True)
+        self._thread.start()
+        return self
+
+    def stop(self, success: bool = True, final_message: str = "") -> None:
+        if self.silent:
+            return
+        self._active = False
+        if self._thread is not None:
+            self._thread.join()
+            self._thread = None
+        if _is_tty():
+            # Clear the spinner line
+            sys.stdout.write("\r\033[K")
+            sys.stdout.flush()
+        # Print final status line
+        if not final_message:
+            final_message = self._message
+        if success:
+            icon = f"{_GREEN}✔{_RESET}" if self._use_colour else "✔"
+        else:
+            icon = f"{_YELLOW}✘{_RESET}" if self._use_colour else "✘"
+        print(f"{icon}  {final_message}", flush=True)
+
+    def update_message(self, message: str) -> None:
+        """Change the message shown next to the spinner in real time."""
+        self._message = message
+
+    # ------------------------------------------------------------------ #
+    # context-manager support
+    # ------------------------------------------------------------------ #
+
+    def __enter__(self) -> "Spinner":
+        return self.start()
+
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+        self.stop(success=exc_type is None)
+        return False  # do not suppress exceptions
+
+    # ------------------------------------------------------------------ #
+    # internal spin loop (runs in background thread)
+    # ------------------------------------------------------------------ #
+
+    def _spin(self) -> None:
+        spinner = itertools.cycle(_SPINNER_FRAMES)
+        while self._active:
+            frame = next(spinner)
+            if self._use_colour:
+                line = f"\r{_CYAN}{_BOLD}{frame}{_RESET}  {self._message} "
+            else:
+                line = f"\r{frame}  {self._message} "
+            sys.stdout.write(line)
+            sys.stdout.flush()
+            time.sleep(0.08)
+        # Final clear is done in stop()
+
+
+class ProgressBar:
+    """
+    Simple zero-dependency terminal progress bar.
+
+    Usage:
+        bar = ProgressBar(total=len(files), label="Scanning")
+        for f in files:
+            process(f)
+            bar.advance()
+        bar.done()
+    """
+
+    def __init__(self, total: int, label: str = "Progress",
+                 width: int = 30, colour: bool = True) -> None:
+        self._total = max(total, 1)
+        self._current = 0
+        self._label = label
+        self._width = width
+        self._use_colour = colour and _is_tty()
+        self._tty = _is_tty()
+
+    def advance(self, n: int = 1) -> None:
+        self._current = min(self._current + n, self._total)
+        if self._tty:
+            self._render()
+
+    def done(self) -> None:
+        self._current = self._total
+        if self._tty:
+            self._render()
+            sys.stdout.write("\n")
+            sys.stdout.flush()
+
+    def _render(self) -> None:
+        pct = self._current / self._total
+        filled = int(self._width * pct)
+        bar_body = "█" * filled + "░" * (self._width - filled)
+
+        if self._use_colour:
+            bar_str = (
+                f"\r{_CYAN}{self._label}{_RESET}  "
+                f"[{_GREEN}{bar_body}{_RESET}] "
+                f"{_BOLD}{int(pct * 100):3d}%{_RESET} "
+                f"({self._current}/{self._total})"
+            )
+        else:
+            bar_str = (
+                f"\r{self._label}  [{bar_body}] "
+                f"{int(pct * 100):3d}% ({self._current}/{self._total})"
+            )
+
+        sys.stdout.write(bar_str)
+        sys.stdout.flush()

repodoctor/structure.py

@@ -0,0 +1,40 @@
+import os
+from typing import Dict, Any
+
+def check_project_structure(root_path: str) -> Dict[str, str]:
+    """
+    Returns PASS, WARN, FAIL, or NOT APPLICABLE
+    """
+    results = {
+        "README": "WARN",
+        ".gitignore": "WARN",
+        "Tests": "WARN",
+        "LICENSE": "WARN",
+        "CI config": "WARN"
+    }
+
+    root = os.path.abspath(root_path)
+
+    # Check README
+    if any(os.path.exists(os.path.join(root, f)) for f in ["README.md", "README.txt", "README"]):
+        results["README"] = "PASS"
+
+    # Check .gitignore
+    if os.path.exists(os.path.join(root, ".gitignore")):
+        results[".gitignore"] = "PASS"
+    elif not os.path.exists(os.path.join(root, ".git")):
+        results[".gitignore"] = "NOT APPLICABLE"
+
+    # Check tests
+    if os.path.exists(os.path.join(root, "tests")) or os.path.exists(os.path.join(root, "test")):
+        results["Tests"] = "PASS"
+
+    # Check LICENSE
+    if any(os.path.exists(os.path.join(root, f)) for f in ["LICENSE", "LICENSE.txt", "LICENSE.md"]):
+        results["LICENSE"] = "PASS"
+
+    # Check CI config
+    if os.path.exists(os.path.join(root, ".github")) or os.path.exists(os.path.join(root, ".gitlab-ci.yml")):
+        results["CI config"] = "PASS"
+    
+    return results

repodoctor/todos.py

@@ -0,0 +1,32 @@
+import re
+from typing import List
+from .models import FileInfo, TodoItem
+
+MARKERS = ["TODO", "FIXME", "HACK", "XXX", "BUG"]
+MARKER_PATTERN = re.compile(r'\b(' + '|'.join(MARKERS) + r')\b')
+
+def scan_todos(files: List[FileInfo]) -> List[TodoItem]:
+    todos = []
+    
+    for f in files:
+        if f.is_binary:
+            continue
+            
+        try:
+            with open(f.path, 'r', encoding='utf-8', errors='ignore') as file:
+                for line_idx, line in enumerate(file):
+                    if MARKER_PATTERN.search(line):
+                        # Extract the actual marker used
+                        match = MARKER_PATTERN.search(line)
+                        marker = match.group(1)
+                        
+                        todos.append(TodoItem(
+                            filepath=f.relative_path,
+                            line_number=line_idx + 1,
+                            text=line.strip(),
+                            marker=marker
+                        ))
+        except Exception:
+            pass
+
+    return todos

repodoctor_cli-1.0.0.dist-info/METADATA

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: repodoctor-cli
+Version: 1.0.0
+Summary: Zero-dependency repository health analyser
+Author: Tanish Jain, Harsh Kumawat
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Environment :: Console
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Dynamic: requires-python
+
+# RepoDoctor
+
+> RepoDoctor diagnoses a codebase for maintainability, security, duplication, project-structure and Git issues using only the language standard library.
+
+## Problem
+Modern development tools rely on heavy dependency chains that are hard to audit, difficult to install in restricted environments, and prone to breaking changes.
+
+## Solution
+RepoDoctor is a production-quality CLI tool that analyzes a software repository and provides an actionable health, security, and maintainability report without a single third-party runtime dependency.
+
+## Features
+- **Multi-Threaded Parallel Scanning**: Asynchronously processes massive codebases in milliseconds.\n- **Animated Terminal UI**: Beautiful typewriter animations and progress spinners.\n- **Multi-Repository Aggregation**: Scan multiple codebases simultaneously and generate unified or independent reports across all flags (HTML, JSON, LLM prompt).\n- **Zero Runtime Dependencies**: Built entirely with Python's standard library.
+- **Single-File Portability**: Can be compiled into a single `repodoctor_single.py` script for extreme portability.
+- **Developer Mood Analyzer**: Scans code comments and commit messages to calculate the emotional state of the project team.
+- **Code Clone Exposer**: Mathematically cross-references all files to expose the two most identical copy-pasted files in the project.
+- **Micro-Linter Engine**: Instantly flags 30+ code smells including profanity filters, wildcard imports, massive JSON configs, and missing alt-text.
+- **LLM Prompt Exporter**: Instantly bundle your entire codebase into a single text file ready for ChatGPT/Claude (`--export-prompt`).
+- **SVG Badge Generator**: Generate valid GitHub-style SVG health badges without image processing libraries (`--badge`).
+- **Terminal ASCII Tree & Bar Charts**: Visual breakdown of your project's folders (`--tree`) and languages natively in your terminal.
+- **AST Cyclomatic Complexity**: Parses Python Abstract Syntax Trees mathematically to score code logic complexity.
+- **Security Scanner**: Detects exposed API keys, credentials, and `.env` files and automatically redacts findings.
+- **Git Analytics & Hotspots**: Leverages native Git to report top contributors, uncommitted changes, and your most frequently edited file (Hotspot).
+- **Codebase Vocabulary Cloud**: Automatically extracts the most frequently used variable and function names across all your files.
+- **Rich Output Formats**: Choose between Animated ANSI-colored terminal, HTML (`--html`), or JSON (`--json`).
+- **Baseline Tracking**: Compare current scans against past reports (`--baseline`) to track regressions over time.
+
+## Architecture
+Modular Python architecture utilizing built-in `argparse`, `subprocess`, `ast`, and `unittest`. Data structures rely on `dataclasses`.
+
+## Installation
+No dependencies are required. Clone the repository or copy the `repodoctor` folder:
+
+```bash
+git clone https://github.com/example/repodoctor.git
+```
+
+## Usage
+Run the package directory against your target repository:
+
+```bash
+python -m repodoctor /path/to/your/repo
+```
+
+### CLI Options
+
+| Flag | Description |
+|---|---|
+| `path` | Path to the repository (default: `.`) |
+| `--json` | Output valid machine-readable JSON |
+| `--html FILE` | Output a self-contained HTML dashboard report |
+| `--export-prompt FILE`| Export the codebase into a single text file for LLM prompting |
+| `--badge FILE` | Generate a GitHub-style SVG health badge |
+| `--tree` | Print an ASCII project directory tree at the top of the report |
+| `--baseline FILE` | Path to a previous JSON report to calculate delta trends |
+| `--no-color` | Disable animated ANSI color output |
+| `--ignore` | Comma-separated list of custom directories to ignore |
+| `--large-file-lines` | Threshold for large file lines (default: 500) |
+| `--duplicate-lines` | Minimum lines for duplicate detection (default: 8) |
+| `--security` | Focus only on security analysis |
+| `--todos` | Focus only on TODO/FIXME analysis |
+| `--git` | Include Git analysis (Always attempts by default) |
+| `--verbose` | Enable verbose logging |
+| `--version` | Display version |
+| `--help` | Display help |
+
+### Exit Codes
+- `0`: Successful scan, no serious findings (secrets or duplicates).
+- `1`: Successful scan with findings.
+- `2`: Invalid CLI usage.
+
+## JSON Format
+Use the `--json` flag to export data.
+```json
+{
+  "repository": { "path": ".", "name": "project" },
+  "summary": { "files": 247, "lines": 38421, "health_score": 78 },
+  "security": { "potential_secrets": 0, "findings": [] },
+  "maintainability": { "large_files": 0, "todos": 5, "duplicates": 0 },
+  "git": { "available": true, "branch": "main", "commits": 142, "uncommitted_changes": 0 },
+  "structure": { "README": "PASS", "Tests": "PASS" }
+}
+```
+
+## Performance
+- Uses efficient filesystem walking (`os.walk`).
+- Early bailing on binary files.
+- Rolling window chunking for O(N) deduplication analysis.
+
+## Security Model
+- **Local Only**: No data is uploaded or transmitted.
+- **Redacted Output**: Secrets are never dumped fully in terminal or JSON.
+- **No Evaluation**: Source code is parsed statically (via AST/Regex), never executed.
+- **Safe Execution**: Git commands strictly avoid shell interpolation to prevent injection.
+
+## Limitations
+- Language detection is extension-based.
+- Duplicate detection is line-based rather than AST-based.
+- Security scanner may yield false positives; human review is required.
+
+## Zero-Dependency Proof
+To verify, run within a fully clean virtual environment:
+```bash
+python -m venv /tmp/repodoctor-test
+source /tmp/repodoctor-test/bin/activate
+pip freeze # (Will be empty)
+python -m repodoctor /path/to/repo1 /path/to/repo2
+```
+
+## Standard Library Substitutions
+See [STDLIB.md](STDLIB.md) for details on how we substituted common third-party tools.
+
+## Testing
+Tested with Python `unittest`:
+```bash
+python -m unittest discover -s tests -v
+```
+
+## Hackathon Information
+Built for the **Zero Dependency | 72-Hour Hackathon**.
+
+## License
+MIT

repodoctor_cli-1.0.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+repodoctor/__init__.py,sha256=OEMGSsx5z9zhqMrY1Qiri25mFUKtpCbn3ZUUAbjl1C8,25
+repodoctor/__main__.py,sha256=wMctmzk1VnpPrTtl1gPg2pLCcMI4qqsoacCIpsPiZoM,15140
+repodoctor/baseline.py,sha256=4DF7XlEdoQoyaNO4-7B3RBQ2T_VWco6b6c4Wz3tuv1k,1557
+repodoctor/cli.py,sha256=tk06dGY8pvi_SVuuc3H6fjBPVQOqh4c9AM2_VNjNGRU,2605
+repodoctor/duplicates.py,sha256=ZPc01cEnj0yIscRaK3uKojVCJVZ6huxq2hXV-KISY80,2695
+repodoctor/git.py,sha256=iZRneYlk6Y0vF7UbDjs0xr7u2sIA5MnVyNfMd_OmeMU,2186
+repodoctor/languages.py,sha256=6IE9iFNIS3kfgTPDan6S_m29l0rCmdnSD4rMw4TThb0,695
+repodoctor/linter.py,sha256=8GyufyGE30Y-lRCovkUXj4bMBSBGbgXBO2dDWJGbfKI,10383
+repodoctor/metrics.py,sha256=nLLCcc3SODdJJX5fOfU87nwhTdTisu6dtWwH0NofHxU,2677
+repodoctor/models.py,sha256=wFDFGjZKhkEIe6iDRu5Pv9c4gm7uKR3lftlo1iFRWkE,1626
+repodoctor/report.py,sha256=lei0l-02Iw8BTchUbAEjqz-K55WAZ5sVAVHWWlcOIfA,16090
+repodoctor/scanner.py,sha256=0cm3Cmde17EvpM12qI8cRwZVnRo3meP9Ka5s_ielJH4,5886
+repodoctor/scoring.py,sha256=fIDySAxVmC0yL3UWRjCn5OwkAR6vWEVnRuPUuHEQXeY,1635
+repodoctor/security.py,sha256=R1haBYjB9zZP_u7vWZmkzDvcVkWgfi2sJ1-lrG5BuSE,2521
+repodoctor/spinner.py,sha256=bZ7cPXZnUXSZ_RM4jyrv6S_gKcy-mfffL43AyM63lLY,5670
+repodoctor/structure.py,sha256=ViHaXTUjkBQwJ01kvkcAJ00PyYAhfufgVQCa34H3W2s,1247
+repodoctor/todos.py,sha256=E0xsmGvkjkjrMcO2IdaK7Qwjq5kCmgtV6FSR6rkLIEM,1066
+repodoctor_cli-1.0.0.dist-info/METADATA,sha256=eXATE7ibyE8jnO8IgHf8xJbQn-zwO2CrQEfztJ25Wzc,6641
+repodoctor_cli-1.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+repodoctor_cli-1.0.0.dist-info/entry_points.txt,sha256=c51JinAxRwn80raaW9iGVHnbQyqQUXwyiVKtTuEch9k,56
+repodoctor_cli-1.0.0.dist-info/top_level.txt,sha256=lheErZ2yZxbqhKX-I6kK39b8IOHHU24X4dLI1H252Gg,11
+repodoctor_cli-1.0.0.dist-info/RECORD,,

repodoctor_cli-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

repodoctor_cli-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+repodoctor = repodoctor.__main__:main

repodoctor_cli-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+repodoctor