pydoctor-cli 0.1.3__tar.gz → 2.0.0__tar.gz

{pydoctor_cli-0.1.3/pydoctor_cli.egg-info → pydoctor_cli-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pydoctor-cli
-Version: 0.1.3
+Version: 2.0.0
 Summary: Premium Python environment diagnostic CLI — your project's personal physician.
 Author-email: Favour Bamgboye <demiladebamgboye@gmail.com>
 Maintainer-email: Favour Bamgboye <demiladebamgboye@gmail.com>
@@ -208,7 +208,7 @@ License:                                  Apache License
         
 Project-URL: Homepage, https://pydoctor.vercel.app
 Project-URL: Repository, https://github.com/iamAgbaCoder/pydoctor-cli
-Project-URL: Documentation, https://github.com/iamAgbaCoder/pydoctor-cli#readme
+Project-URL: Documentation, https://pydoctor.vercel.app/docs
 Project-URL: Bug Tracker, https://github.com/iamAgbaCoder/pydoctor-cli/issues
 Project-URL: Changelog, https://github.com/iamAgbaCoder/pydoctor-cli/releases
 Keywords: pydoctor,diagnosis,dependency-checker,vulnerability-scanner,python-health,cli-tool,security-audit,static-analysis
@@ -323,6 +323,21 @@ pydoctor fix
 
 ## Release History
 
+### v2.0.0
+
+- **🚀 Major UI/UX Revamp**: Introduced a premium "kernel/hacker" aesthetic with boxed reports, dynamic progress animations, and improved readability.
+- **🛡️ CI/CD Guard Mode**: New `pydoctor check --ci` command to detect exposed secrets (AWS, GitHub, PyPI tokens) and insecure workflow patterns in GitHub Actions/GitLab CI.
+- **🐳 Docker Support**: New `pydoctor docker` command to diagnose Python issues inside containers and audit Dockerfiles.
+- **🐙 GitHub Integration**: New `pydoctor github` command for repository-wide health scans and local git configuration audits.
+- **📈 Advanced Health Scoring**: Refined the 0-100 scoring algorithm with granular penalties for security vulnerabilities and CI/CD risks.
+- **⚡ Performance Boost**: Parallel execution engine for scanning large codebases faster.
+- **🔍 Smart Environment Detection**: Now automatically prompts users when no venv is found, preventing accidental system-wide changes.
+- **🎯 Context-Aware Reporting**: Targeted commands (like `pydoctor scan-unused` or `pydoctor github`) now intelligently suppress unrelated scanner noise.
+- **🧠 OSV Deep-Fetching**: Overcame upstream OSV API batch limits by implementing dynamic real-time fetching and caching of full vulnerability advisories natively.
+- **🔗 Transitive Dependency Tracking**: PyDoctor now uniquely segregates mathematical/transitive dependencies from pure unused bloat, effectively preventing `pydoctor fix` from uninstalling required sub-packages.
+- **🛠️ Refined Git Discovery**: Utilizes native git heuristics (`--is-inside-work-tree` & `--show-toplevel`) to flawlessly map out project roots and repository states, even when scanning from deeply nested sub-directories.
+- **🔮 Dynamic Fix Suggestions**: The `🚀 Next Steps` terminal guide now dynamically rules out the currently running command and gracefully self-hides when a project achieves a perfect 100/100 health rating.
+
 ### v0.1.3
 
 - **Enhanced Package Detection**: Pydoctor now intelligently detects and uses your project's specific virtual environment (Poetry, UV, PDM, or standard venv) to run all scans and diagnoses.

{pydoctor_cli-0.1.3 → pydoctor_cli-2.0.0}/README.md

@@ -74,6 +74,21 @@ pydoctor fix
 
 ## Release History
 
+### v2.0.0
+
+- **🚀 Major UI/UX Revamp**: Introduced a premium "kernel/hacker" aesthetic with boxed reports, dynamic progress animations, and improved readability.
+- **🛡️ CI/CD Guard Mode**: New `pydoctor check --ci` command to detect exposed secrets (AWS, GitHub, PyPI tokens) and insecure workflow patterns in GitHub Actions/GitLab CI.
+- **🐳 Docker Support**: New `pydoctor docker` command to diagnose Python issues inside containers and audit Dockerfiles.
+- **🐙 GitHub Integration**: New `pydoctor github` command for repository-wide health scans and local git configuration audits.
+- **📈 Advanced Health Scoring**: Refined the 0-100 scoring algorithm with granular penalties for security vulnerabilities and CI/CD risks.
+- **⚡ Performance Boost**: Parallel execution engine for scanning large codebases faster.
+- **🔍 Smart Environment Detection**: Now automatically prompts users when no venv is found, preventing accidental system-wide changes.
+- **🎯 Context-Aware Reporting**: Targeted commands (like `pydoctor scan-unused` or `pydoctor github`) now intelligently suppress unrelated scanner noise.
+- **🧠 OSV Deep-Fetching**: Overcame upstream OSV API batch limits by implementing dynamic real-time fetching and caching of full vulnerability advisories natively.
+- **🔗 Transitive Dependency Tracking**: PyDoctor now uniquely segregates mathematical/transitive dependencies from pure unused bloat, effectively preventing `pydoctor fix` from uninstalling required sub-packages.
+- **🛠️ Refined Git Discovery**: Utilizes native git heuristics (`--is-inside-work-tree` & `--show-toplevel`) to flawlessly map out project roots and repository states, even when scanning from deeply nested sub-directories.
+- **🔮 Dynamic Fix Suggestions**: The `🚀 Next Steps` terminal guide now dynamically rules out the currently running command and gracefully self-hides when a project achieves a perfect 100/100 health rating.
+
 ### v0.1.3
 
 - **Enhanced Package Detection**: Pydoctor now intelligently detects and uses your project's specific virtual environment (Poetry, UV, PDM, or standard venv) to run all scans and diagnoses.

{pydoctor_cli-0.1.3 → pydoctor_cli-2.0.0}/pydoctor/__init__.py

@@ -9,6 +9,6 @@ Author: Favour Bamgboye
 License: MIT
 """
 
-__version__ = "0.1.0"
+__version__ = "2.0.0"
 __author__ = "Favour Bamgboye"
 __description__ = "Python environment diagnostic CLI — your project's doctor."

pydoctor_cli-2.0.0/pydoctor/analysis/health_score.py

@@ -0,0 +1,82 @@
+"""
+pydoctor/analysis/health_score.py
+──────────────────────────────────
+Calculates the numerical project health score and verdict.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from pydoctor.core.report import DiagnosisReport, Issue
+
+
+@dataclass
+class HealthMetrics:
+    score: int
+    verdict: str
+    message: str
+
+
+def calculate_health(report: DiagnosisReport) -> HealthMetrics:
+    """
+    Calculate project health score (0-100) based on identified issues.
+    """
+    score = _compute_score(report)
+    categories = list({i.category for i in report.issues})
+    return _get_verdict(score, categories)
+
+
+def _compute_score(report: DiagnosisReport) -> int:
+    score = 100
+    for issue in report.issues:
+        score -= _calculate_issue_penalty(issue)
+    return max(0, score)
+
+
+def _calculate_issue_penalty(issue: Issue) -> int:
+    sev = issue.severity.lower()
+    if sev in ("ok", "info"):
+        return 0
+
+    if issue.category == "security":
+        if sev == "critical":
+            return 25  # Increased penalty for security
+        if sev == "error":
+            return 12
+        return 6
+    if issue.category == "dependencies":
+        return 8
+    if issue.category == "outdated":
+        return 3
+    if issue.category == "unused":
+        return 2
+    if issue.category == "environment":
+        return 15 if sev in ("error", "critical") else 5
+    if issue.category == "ci":
+        return 20 if sev == "critical" else 10
+    return 0
+
+
+def _get_verdict(score: int, categories: list[str]) -> HealthMetrics:
+    is_partial = len(categories) == 1
+    cat_name = categories[0].capitalize() if is_partial else "Project"
+
+    if score >= 90:
+        verdict = "Excellent"
+        message = (
+            f"Your {cat_name} is healthy and ready for production."
+            if is_partial
+            else "Your project is healthy and ready for production."
+        )
+    elif score >= 70:
+        verdict = "Good"
+        message = f"Your {cat_name} is functional but has some minor issues to clear up."
+    elif score >= 50:
+        verdict = "Needs Attention"
+        message = f"Your {cat_name} has notable risks. Consider addressing warnings carefully."
+    else:
+        verdict = "Critical"
+        message = f"Your {cat_name} contains severe risks that should be fixed before production deployment."
+
+    return HealthMetrics(score=score, verdict=verdict, message=message)