diff --git a/src/agentready/cli/main.py b/src/agentready/cli/main.py index 582e8d4..54e0f71 100644 --- a/src/agentready/cli/main.py +++ b/src/agentready/cli/main.py @@ -6,6 +6,12 @@ import click +try: + from importlib.metadata import version as get_version +except ImportError: + # Python 3.7 compatibility + from importlib_metadata import version as get_version + from ..assessors.code_quality import ( CyclomaticComplexityAssessor, TypeAnnotationsAssessor, @@ -29,6 +35,19 @@ from .bootstrap import bootstrap from .demo import demo from .learn import learn +from .repomix import repomix_generate + + +def get_agentready_version() -> str: + """Get AgentReady version from package metadata. + + Returns: + Version string (e.g., "1.0.0") or "unknown" if not installed + """ + try: + return get_version("agentready") + except Exception: + return "unknown" def create_all_assessors(): @@ -152,7 +171,8 @@ def run_assessment(repository_path, verbose, output_dir, config_path): # Run scan try: - assessment = scanner.scan(assessors, verbose=verbose) + version = get_agentready_version() + assessment = scanner.scan(assessors, verbose=verbose, version=version) except Exception as e: click.echo(f"Error during assessment: {str(e)}", err=True) if verbose: @@ -286,11 +306,13 @@ def generate_config(): cli.add_command(bootstrap) cli.add_command(demo) cli.add_command(learn) +cli.add_command(repomix_generate) def show_version(): """Show version information.""" - click.echo("AgentReady Repository Scorer v1.0.0") + version = get_agentready_version() + click.echo(f"AgentReady Repository Scorer v{version}") click.echo("Research Report: bundled") diff --git a/src/agentready/models/__init__.py b/src/agentready/models/__init__.py index 58d17ed..48b9a05 100644 --- a/src/agentready/models/__init__.py +++ b/src/agentready/models/__init__.py @@ -6,10 +6,12 @@ from agentready.models.config import Config from agentready.models.discovered_skill import DiscoveredSkill from agentready.models.finding import Finding +from agentready.models.metadata import AssessmentMetadata from agentready.models.repository import Repository __all__ = [ "Assessment", + "AssessmentMetadata", "Attribute", "Citation", "Config", diff --git a/src/agentready/models/assessment.py b/src/agentready/models/assessment.py index 9158ce3..b3bb372 100644 --- a/src/agentready/models/assessment.py +++ b/src/agentready/models/assessment.py @@ -6,6 +6,7 @@ from .config import Config from .discovered_skill import DiscoveredSkill from .finding import Finding +from .metadata import AssessmentMetadata from .repository import Repository @@ -25,6 +26,7 @@ class Assessment: config: Custom configuration used (if any) duration_seconds: Time taken for assessment discovered_skills: Patterns extracted from this assessment (optional) + metadata: Execution context (version, user, command, timestamp) """ repository: Repository @@ -38,6 +40,7 @@ class Assessment: config: Config | None duration_seconds: float discovered_skills: list[DiscoveredSkill] = field(default_factory=list) + metadata: AssessmentMetadata | None = None VALID_LEVELS = {"Platinum", "Gold", "Silver", "Bronze", "Needs Improvement"} @@ -70,6 +73,7 @@ def __post_init__(self): def to_dict(self) -> dict: """Convert to dictionary for JSON serialization.""" return { + "metadata": self.metadata.to_dict() if self.metadata else None, "repository": self.repository.to_dict(), "timestamp": self.timestamp.isoformat(), "overall_score": self.overall_score, diff --git a/src/agentready/models/metadata.py b/src/agentready/models/metadata.py new file mode 100644 index 0000000..54167ef --- /dev/null +++ b/src/agentready/models/metadata.py @@ -0,0 +1,88 @@ +"""Assessment metadata model for execution context and reproducibility.""" + +import getpass +import os +import socket +from dataclasses import dataclass +from datetime import datetime + + +@dataclass +class AssessmentMetadata: + """Metadata about the assessment execution context. + + Captures who ran the assessment, when, with what version, and what command. + Critical for reproducibility, debugging, and multi-repository workflows. + + Attributes: + agentready_version: Version of AgentReady used (e.g., "1.0.0") + assessment_timestamp: ISO 8601 timestamp of when assessment started + assessment_timestamp_human: Human-readable timestamp (e.g., "November 21, 2025 at 2:11 AM") + executed_by: Username and hostname (e.g., "jeder@macbook") + command: Full CLI command executed (e.g., "agentready assess . --verbose") + working_directory: Absolute path of current working directory when executed + """ + + agentready_version: str + assessment_timestamp: str # ISO 8601 format + assessment_timestamp_human: str + executed_by: str + command: str + working_directory: str + + def to_dict(self) -> dict: + """Convert to dictionary for JSON serialization.""" + return { + "agentready_version": self.agentready_version, + "assessment_timestamp": self.assessment_timestamp, + "assessment_timestamp_human": self.assessment_timestamp_human, + "executed_by": self.executed_by, + "command": self.command, + "working_directory": self.working_directory, + } + + @classmethod + def create( + cls, version: str, timestamp: datetime, command: str + ) -> "AssessmentMetadata": + """Create metadata from execution context. + + Args: + version: AgentReady version string + timestamp: Assessment start time + command: CLI command executed + + Returns: + AssessmentMetadata instance + """ + # Get username and hostname + try: + username = getpass.getuser() + except Exception: + username = "unknown" + + try: + hostname = socket.gethostname().split(".")[0] # Short hostname + except Exception: + hostname = "unknown" + + executed_by = f"{username}@{hostname}" + + # Format timestamps + iso_timestamp = timestamp.isoformat() + human_timestamp = timestamp.strftime("%B %d, %Y at %-I:%M %p") + + # Get current working directory + try: + working_dir = os.getcwd() + except Exception: + working_dir = "unknown" + + return cls( + agentready_version=version, + assessment_timestamp=iso_timestamp, + assessment_timestamp_human=human_timestamp, + executed_by=executed_by, + command=command, + working_directory=working_dir, + ) diff --git a/src/agentready/reporters/html.py b/src/agentready/reporters/html.py index e6618c0..7c4fb92 100644 --- a/src/agentready/reporters/html.py +++ b/src/agentready/reporters/html.py @@ -57,6 +57,7 @@ def generate(self, assessment: Assessment, output_path: Path) -> Path: "findings": assessment.findings, "duration_seconds": assessment.duration_seconds, "config": assessment.config, + "metadata": assessment.metadata, # Embed assessment JSON for JavaScript "assessment_json": json.dumps(assessment.to_dict()), } diff --git a/src/agentready/reporters/markdown.py b/src/agentready/reporters/markdown.py index bbdab6c..7c0c31b 100644 --- a/src/agentready/reporters/markdown.py +++ b/src/agentready/reporters/markdown.py @@ -62,17 +62,32 @@ def generate(self, assessment: Assessment, output_path: Path) -> Path: return output_path def _generate_header(self, assessment: Assessment) -> str: - """Generate report header with repository info.""" - # Get git remote URL if available, otherwise use repo name - repo_display = assessment.repository.url if assessment.repository.url else assessment.repository.name - - return f"""# 🤖 AgentReady Assessment Report + """Generate report header with repository info and metadata.""" + header = "# 🤖 AgentReady Assessment Report\n\n" + + # Repository information + header += f"**Repository**: {assessment.repository.name}\n" + header += f"**Path**: `{assessment.repository.path}`\n" + header += f"**Branch**: `{assessment.repository.branch}` | **Commit**: `{assessment.repository.commit_hash[:8]}`\n" + + # Assessment metadata (if available) + if assessment.metadata: + header += ( + f"**Assessed**: {assessment.metadata.assessment_timestamp_human}\n" + ) + header += ( + f"**AgentReady Version**: {assessment.metadata.agentready_version}\n" + ) + header += f"**Run by**: {assessment.metadata.executed_by}\n" + else: + # Fallback to timestamp if metadata not available + header += ( + f"**Assessed**: {assessment.timestamp.strftime('%B %d, %Y at %H:%M')}\n" + ) -| Repository | Branch | Commit | Score | Level | Date | -|------------|--------|--------|-------|-------|------| -| **{repo_display}** | {assessment.repository.branch} | `{assessment.repository.commit_hash[:8]}` | **{assessment.overall_score:.1f}/100** | **{assessment.certification_level}** | {assessment.timestamp.strftime('%Y-%m-%d %H:%M')} | + header += "\n---" ----""" + return header def _generate_summary(self, assessment: Assessment) -> str: """Generate summary section with key metrics.""" diff --git a/src/agentready/services/scanner.py b/src/agentready/services/scanner.py index 55fd4ae..4a6da76 100644 --- a/src/agentready/services/scanner.py +++ b/src/agentready/services/scanner.py @@ -1,5 +1,6 @@ """Scanner service orchestrating the assessment workflow.""" +import sys import time from datetime import datetime from pathlib import Path @@ -9,6 +10,7 @@ from ..models.assessment import Assessment from ..models.config import Config from ..models.finding import Finding +from ..models.metadata import AssessmentMetadata from ..models.repository import Repository from .language_detector import LanguageDetector from .scorer import Scorer @@ -63,12 +65,20 @@ def _validate_repository(self): if not (self.repository_path / ".git").exists(): raise ValueError(f"Not a git repository: {self.repository_path}") - def scan(self, assessors: list, verbose: bool = False) -> Assessment: + def scan( + self, + assessors: list, + verbose: bool = False, + version: str = "unknown", + command: str | None = None, + ) -> Assessment: """Execute full assessment workflow. Args: assessors: List of assessor instances to run verbose: Enable detailed progress logging + version: AgentReady version string + command: CLI command executed (reconstructed from sys.argv if None) Returns: Complete Assessment with findings and scores @@ -81,6 +91,7 @@ def scan(self, assessors: list, verbose: bool = False) -> Assessment: 5. Return Assessment """ start_time = time.time() + timestamp = datetime.now() if verbose: print(f"Scanning repository: {self.repository_path.name}") @@ -107,6 +118,15 @@ def scan(self, assessors: list, verbose: bool = False) -> Assessment: duration = time.time() - start_time + # Create metadata + if command is None: + # Reconstruct command from sys.argv + command = " ".join(sys.argv) + + metadata = AssessmentMetadata.create( + version=version, timestamp=timestamp, command=command + ) + if verbose: print(f"\nAssessment complete in {duration:.1f}s") print(f"Overall Score: {overall_score}/100 ({certification_level})") @@ -116,7 +136,7 @@ def scan(self, assessors: list, verbose: bool = False) -> Assessment: return Assessment( repository=repository, - timestamp=datetime.now(), + timestamp=timestamp, overall_score=overall_score, certification_level=certification_level, attributes_assessed=assessed, @@ -125,6 +145,7 @@ def scan(self, assessors: list, verbose: bool = False) -> Assessment: findings=findings, config=self.config, duration_seconds=round(duration, 1), + metadata=metadata, ) def _build_repository_model(self, verbose: bool = False) -> Repository: @@ -202,7 +223,7 @@ def _execute_assessor( ) except Exception as e: if verbose: - print(f"error (applicability check failed)") + print("error (applicability check failed)") return Finding.error( assessor.attribute, reason=f"Applicability check failed: {str(e)}" ) diff --git a/src/agentready/templates/report.html.j2 b/src/agentready/templates/report.html.j2 index 1fa48d3..99dfcab 100644 --- a/src/agentready/templates/report.html.j2 +++ b/src/agentready/templates/report.html.j2 @@ -39,12 +39,49 @@ h1 { font-size: 2rem; color: #1e293b; + margin-bottom: 15px; + } + + .report-header { + display: grid; + grid-template-columns: 1fr auto; + gap: 30px; + margin-bottom: 20px; + } + + .repo-info h2 { + font-size: 1.5rem; + color: #1e293b; + font-weight: 700; margin-bottom: 10px; } - .subtitle { + .repo-info .info-line { + color: #475569; + font-size: 0.95rem; + margin: 6px 0; + font-family: 'Courier New', monospace; + } + + .repo-info .info-line code { + background: #f1f5f9; + padding: 2px 8px; + border-radius: 3px; + color: #1e293b; + } + + .meta-info { + text-align: right; color: #64748b; - font-size: 1rem; + font-size: 0.9rem; + } + + .meta-info .info-line { + margin: 6px 0; + } + + .meta-info strong { + color: #475569; } /* Summary Cards */ @@ -407,7 +444,20 @@

🤖 AgentReady Assessment Report

-

{{ repository.name }} • {{ timestamp.strftime('%B %d, %Y at %H:%M') }}

+
+
+

{{ repository.name }}

+
📁 {{ repository.path }}
+
🌿 {{ repository.branch }} @ {{ repository.commit_hash[:8] }}
+
+ {% if metadata %} +
+
Assessed: {{ metadata.assessment_timestamp_human }}
+
AgentReady: v{{ metadata.agentready_version }}
+
Run by: {{ metadata.executed_by }}
+
+ {% endif %} +
diff --git a/tests/unit/test_models.py b/tests/unit/test_models.py index b653e4b..6b1f3fe 100644 --- a/tests/unit/test_models.py +++ b/tests/unit/test_models.py @@ -8,7 +8,8 @@ from agentready.models.assessment import Assessment from agentready.models.attribute import Attribute from agentready.models.config import Config -from agentready.models.finding import Citation, Finding, Remediation +from agentready.models.finding import Finding, Remediation +from agentready.models.metadata import AssessmentMetadata from agentready.models.repository import Repository @@ -311,3 +312,119 @@ def test_assessment_determine_certification(self): assert Assessment.determine_certification_level(65.0) == "Silver" assert Assessment.determine_certification_level(45.0) == "Bronze" assert Assessment.determine_certification_level(20.0) == "Needs Improvement" + + +class TestAssessmentMetadata: + """Test AssessmentMetadata model.""" + + def test_metadata_create(self): + """Test creating metadata from execution context.""" + timestamp = datetime(2025, 11, 21, 2, 11, 5) + metadata = AssessmentMetadata.create( + version="1.0.0", + timestamp=timestamp, + command="agentready assess . --verbose", + ) + + assert metadata.agentready_version == "1.0.0" + assert metadata.command == "agentready assess . --verbose" + assert "2025" in metadata.assessment_timestamp # ISO format + assert "November 21, 2025" in metadata.assessment_timestamp_human + assert "@" in metadata.executed_by # Should have user@host format + assert len(metadata.working_directory) > 0 + + def test_metadata_to_dict(self): + """Test metadata serialization.""" + timestamp = datetime(2025, 11, 21, 2, 11, 5) + metadata = AssessmentMetadata.create( + version="1.0.0", timestamp=timestamp, command="agentready assess ." + ) + + data = metadata.to_dict() + assert data["agentready_version"] == "1.0.0" + assert data["command"] == "agentready assess ." + assert "assessment_timestamp" in data + assert "assessment_timestamp_human" in data + assert "executed_by" in data + assert "working_directory" in data + + def test_metadata_manual_creation(self): + """Test manually creating metadata with all fields.""" + metadata = AssessmentMetadata( + agentready_version="1.2.3", + assessment_timestamp="2025-11-21T02:11:05", + assessment_timestamp_human="November 21, 2025 at 2:11 AM", + executed_by="testuser@testhost", + command="agentready assess /path/to/repo", + working_directory="/home/user", + ) + + assert metadata.agentready_version == "1.2.3" + assert metadata.executed_by == "testuser@testhost" + assert metadata.working_directory == "/home/user" + + def test_assessment_with_metadata(self, tmp_path): + """Test that Assessment can include metadata.""" + git_dir = tmp_path / ".git" + git_dir.mkdir() + + repo = Repository( + path=tmp_path, + name="test", + url=None, + branch="main", + commit_hash="abc", + languages={}, + total_files=10, + total_lines=100, + ) + + timestamp = datetime.now() + metadata = AssessmentMetadata.create( + version="1.0.0", timestamp=timestamp, command="agentready assess ." + ) + + attr = Attribute( + id="test", + name="Test", + category="Test", + tier=1, + description="Test", + criteria="Test", + default_weight=0.04, + ) + findings = [ + Finding( + attribute=attr, + status="pass", + score=100.0, + measured_value="test", + threshold="test", + evidence=[], + remediation=None, + error_message=None, + ) + for _ in range(25) + ] + + assessment = Assessment( + repository=repo, + timestamp=timestamp, + overall_score=75.0, + certification_level="Gold", + attributes_assessed=25, + attributes_skipped=0, + attributes_total=25, + findings=findings, + config=None, + duration_seconds=1.5, + metadata=metadata, + ) + + assert assessment.metadata is not None + assert assessment.metadata.agentready_version == "1.0.0" + + # Test serialization includes metadata + data = assessment.to_dict() + assert data["metadata"] is not None + assert data["metadata"]["agentready_version"] == "1.0.0"