gitrelevance 0.1.0__tar.gz

gitrelevance-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    name: Test on Python ${{ matrix.python-version }} (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: "pip"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+
+      - name: Run test suite
+        run: |
+          python -m pytest tests/ -v

gitrelevance-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GitRelevance Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gitrelevance-0.1.0/PKG-INFO

@@ -0,0 +1,269 @@
+Metadata-Version: 2.5
+Name: gitrelevance
+Version: 0.1.0
+Summary: Analyze whether historical GitHub issues are still relevant to a codebase, using Git history as evidence
+Project-URL: Homepage, https://github.com/gitrelevance/gitrelevance
+Project-URL: Repository, https://github.com/gitrelevance/gitrelevance
+Project-URL: Issues, https://github.com/gitrelevance/gitrelevance/issues
+Author: GitRelevance Contributors
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.10
+Requires-Dist: diskcache>=5.6.0
+Requires-Dist: gitpython>=3.1.0
+Requires-Dist: pygithub>=2.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.9.0
+Requires-Dist: typing-extensions; python_version < '3.11'
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: responses>=0.23.0; extra == 'dev'
+Requires-Dist: twine>=5.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# GitRelevance
+
+> Analyze whether historical GitHub issues are still relevant to a codebase, using Git history as evidence.
+
+[![CI](https://github.com/gitrelevance/gitrelevance/actions/workflows/ci.yml/badge.svg)](https://github.com/gitrelevance/gitrelevance/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python: >=3.10](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+
+---
+
+## What is GitRelevance?
+
+In long-lived repositories, issue trackers often accumulate hundreds of historical bug reports and feature requests. Over time, code is refactored, features are deprecated, or fixes are merged without closing the original issue.
+
+**GitRelevance** audits your open and closed GitHub issues against your local Git history. It automatically correlates commit messages, pull request merges, file renames, deletions, and reverts to determine whether an issue is:
+- **`RESOLVED`** — A fix commit exists in `HEAD` history and was not reverted.
+- **`PROBABLY_RESOLVED`** — A fixing PR was merged or substantial fix evidence was detected.
+- **`STILL_RELEVANT`** — The issue is open and related code still actively exists in the tree.
+- **`OBSOLETE`** — The files or feature referenced by the issue were deleted without replacement.
+- **`UNKNOWN`** — No correlating commits or evidence exist in local Git history.
+
+Every classification is backed by an explicit, human-readable list of evidence items and a confidence score.
+
+---
+
+## Installation
+
+```bash
+pip install gitrelevance
+```
+
+For development:
+```bash
+git clone https://github.com/gitrelevance/gitrelevance.git
+cd gitrelevance
+pip install -e ".[dev]"
+```
+
+Requires Python ≥ 3.10.
+
+---
+
+## Quick Start (CLI)
+
+Run `gitrelevance analyze` from inside any local Git clone of a GitHub repository:
+
+```bash
+# Analyze all repository issues
+gitrelevance analyze
+
+# Filter by state (open, closed, all)
+gitrelevance analyze --state open
+
+# Filter by issue creation date
+gitrelevance analyze --since 2024-01-01
+
+# Output structured JSON for automation or CI pipelines
+gitrelevance analyze --json
+```
+
+### Example Terminal Output
+
+```
+GitRelevance
+
+Repository: github.com/owner/my-repo
+Branch: main
+HEAD: a81f23c
+
+Analyzing 24 issues...
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+RESOLVED
+
+#21 Login crashes after token expiration
+Confidence: 96%
+
+Evidence:
+  ✓ Fix commit is present in HEAD history (a81f23c)
+  ✓ Issue referenced in commit message (a81f23c)
+  ✓ All related files exist at HEAD
+  ✓ No revert of fix commit detected (a81f23c)
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+* Confidence is a heuristic evidence-strength score (0–100%), not a statistical probability.
+```
+
+---
+
+## How Classification Works
+
+GitRelevance evaluates evidence through a multi-stage deterministic pipeline:
+
+```
+┌─────────────────┐     ┌─────────────────────┐
+│ Local Git Repo  │     │ GitHub API Provider │
+└────────┬────────┘     └──────────┬──────────┘
+         │                         │
+         ▼                         ▼
+  ┌───────────────────────────────────────┐
+  │ Matcher (Correlates commits & PRs)    │
+  └──────────────────┬────────────────────┘
+                     │
+                     ▼
+  ┌───────────────────────────────────────┐
+  │ Current-State Analysis (HEAD status)  │
+  └──────────────────┬────────────────────┘
+                     │
+                     ▼
+  ┌───────────────────────────────────────┐
+  │ Evidence Collection (Signed weights)  │
+  └──────────────────┬────────────────────┘
+                     │
+                     ▼
+  ┌───────────────────────────────────────┐
+  │ Confidence & Classifier Decision Tree │
+  └──────────────────┬────────────────────┘
+                     │
+                     ▼
+  ┌───────────────────────────────────────┐
+  │ Output (Terminal with Rich or JSON)   │
+  └───────────────────────────────────────┘
+```
+
+### Evidence Rules & Signed Weights
+- **Fix commit in HEAD history** (`+3`): A commit referencing `#N` or `GH-N` is an ancestor of `HEAD`.
+- **Linked PR merged** (`+2`): A pull request linked to or closing issue `#N` was merged into the repository.
+- **Related files exist at HEAD** (`+2`): All files modified by the issue's commits/PRs still exist.
+- **No revert detected** (`+1`): The fix commit was not undone by a subsequent `git revert`.
+- **Related files deleted without replacement** (`-3`): Referenced files were deleted in git history and not renamed.
+- **Fix commit later reverted** (`-3`): Git's native revert trailer (`This reverts commit <sha>.`) indicates the fix was undone.
+
+### Confidence Score (Evidence Strength)
+
+Confidence is computed as an **evidence-strength heuristic** normalized and clamped to `[0.05, 0.98]`.
+
+```text
+Confidence = 0.50 + (sum(Weights) / (2 × MAX_ABS_WEIGHT))
+```
+> **Important Note:** Confidence is **NOT** a calibrated Bayesian probability. A confidence of 95% indicates an overwhelming accumulation of strong supporting evidence in the Git tree, not that the classification is statistically 95% likely to be correct.
+
+---
+
+## GitHub Authentication & Rate Limits
+
+GitRelevance works unauthenticated for public repositories out of the box.
+
+To analyze private repositories or avoid GitHub's unauthenticated API rate limits (60 requests/hour), supply a personal access token via the `GITHUB_TOKEN` environment variable or a local `.env` file:
+
+```bash
+export GITHUB_TOKEN="ghp_yourPersonalAccessTokenHere"
+gitrelevance analyze
+```
+
+---
+
+## Python API Usage
+
+GitRelevance can also be integrated directly into Python scripts:
+
+```python
+from gitrelevance.git.repository import GitRepository
+from gitrelevance.providers.github import GitHubProvider
+from gitrelevance.analysis.engine import AnalysisEngine
+from gitrelevance.output.terminal import TerminalRenderer
+from gitrelevance.output.json import to_json
+
+# 1. Initialize Git repository and GitHub provider
+repo = GitRepository(".")
+owner, repo_name = GitHubProvider.parse_remote(repo.remote_url("origin"))
+provider = GitHubProvider(owner=owner, repo=repo_name)
+
+# 2. Run analysis
+engine = AnalysisEngine(repo, provider)
+results = engine.analyze(state="open")
+
+# 3. Render results
+for result in results:
+    print(f"#{result.issue.number} {result.issue.title} -> {result.classification.value} ({result.confidence:.0%})")
+```
+
+---
+
+## Running Tests
+
+```bash
+# Run complete test suite
+pytest -v
+
+# Run individual test layers
+pytest tests/git/           # Git abstraction layer
+pytest tests/providers/     # Provider layer
+pytest tests/analysis/      # Evidence & classification unit tests
+pytest tests/output/        # Terminal & JSON rendering tests
+pytest tests/cli/           # Typer CLI tests
+pytest tests/scenarios/     # End-to-end repository scenarios
+```
+
+---
+
+## Adding a Scenario Test
+
+To add a new end-to-end scenario test:
+1. Create `tests/scenarios/test_scenario_<name>.py`.
+2. Import `FakeProvider`, `make_issue`, `make_pr`, and assertion helpers from `tests.scenarios.conftest`.
+3. Use `RepoBuilder` to construct a real temporary Git repository.
+4. Execute `AnalysisEngine(repo, provider).analyze()` and assert on the `AnalysisResult` fields.
+
+```python
+from gitrelevance.analysis.engine import AnalysisEngine
+from gitrelevance.git.repository import GitRepository
+from gitrelevance.models import Classification
+from tests.fixtures.repo_builder import RepoBuilder
+from tests.scenarios.conftest import FakeProvider, make_issue
+
+def test_my_custom_scenario():
+    builder = RepoBuilder().commit("Initial", files={"app.py": "code"})
+    path = builder.build()
+    try:
+        repo = GitRepository(path)
+        issue = make_issue(number=99, title="Custom issue", state="closed")
+        results = AnalysisEngine(repo, FakeProvider(issues=[issue])).analyze()
+        assert results[0].classification == Classification.UNKNOWN
+    finally:
+        builder.cleanup()
+```
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

gitrelevance-0.1.0/README.md

@@ -0,0 +1,234 @@
+# GitRelevance
+
+> Analyze whether historical GitHub issues are still relevant to a codebase, using Git history as evidence.
+
+[![CI](https://github.com/gitrelevance/gitrelevance/actions/workflows/ci.yml/badge.svg)](https://github.com/gitrelevance/gitrelevance/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python: >=3.10](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+
+---
+
+## What is GitRelevance?
+
+In long-lived repositories, issue trackers often accumulate hundreds of historical bug reports and feature requests. Over time, code is refactored, features are deprecated, or fixes are merged without closing the original issue.
+
+**GitRelevance** audits your open and closed GitHub issues against your local Git history. It automatically correlates commit messages, pull request merges, file renames, deletions, and reverts to determine whether an issue is:
+- **`RESOLVED`** — A fix commit exists in `HEAD` history and was not reverted.
+- **`PROBABLY_RESOLVED`** — A fixing PR was merged or substantial fix evidence was detected.
+- **`STILL_RELEVANT`** — The issue is open and related code still actively exists in the tree.
+- **`OBSOLETE`** — The files or feature referenced by the issue were deleted without replacement.
+- **`UNKNOWN`** — No correlating commits or evidence exist in local Git history.
+
+Every classification is backed by an explicit, human-readable list of evidence items and a confidence score.
+
+---
+
+## Installation
+
+```bash
+pip install gitrelevance
+```
+
+For development:
+```bash
+git clone https://github.com/gitrelevance/gitrelevance.git
+cd gitrelevance
+pip install -e ".[dev]"
+```
+
+Requires Python ≥ 3.10.
+
+---
+
+## Quick Start (CLI)
+
+Run `gitrelevance analyze` from inside any local Git clone of a GitHub repository:
+
+```bash
+# Analyze all repository issues
+gitrelevance analyze
+
+# Filter by state (open, closed, all)
+gitrelevance analyze --state open
+
+# Filter by issue creation date
+gitrelevance analyze --since 2024-01-01
+
+# Output structured JSON for automation or CI pipelines
+gitrelevance analyze --json
+```
+
+### Example Terminal Output
+
+```
+GitRelevance
+
+Repository: github.com/owner/my-repo
+Branch: main
+HEAD: a81f23c
+
+Analyzing 24 issues...
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+RESOLVED
+
+#21 Login crashes after token expiration
+Confidence: 96%
+
+Evidence:
+  ✓ Fix commit is present in HEAD history (a81f23c)
+  ✓ Issue referenced in commit message (a81f23c)
+  ✓ All related files exist at HEAD
+  ✓ No revert of fix commit detected (a81f23c)
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+* Confidence is a heuristic evidence-strength score (0–100%), not a statistical probability.
+```
+
+---
+
+## How Classification Works
+
+GitRelevance evaluates evidence through a multi-stage deterministic pipeline:
+
+```
+┌─────────────────┐     ┌─────────────────────┐
+│ Local Git Repo  │     │ GitHub API Provider │
+└────────┬────────┘     └──────────┬──────────┘
+         │                         │
+         ▼                         ▼
+  ┌───────────────────────────────────────┐
+  │ Matcher (Correlates commits & PRs)    │
+  └──────────────────┬────────────────────┘
+                     │
+                     ▼
+  ┌───────────────────────────────────────┐
+  │ Current-State Analysis (HEAD status)  │
+  └──────────────────┬────────────────────┘
+                     │
+                     ▼
+  ┌───────────────────────────────────────┐
+  │ Evidence Collection (Signed weights)  │
+  └──────────────────┬────────────────────┘
+                     │
+                     ▼
+  ┌───────────────────────────────────────┐
+  │ Confidence & Classifier Decision Tree │
+  └──────────────────┬────────────────────┘
+                     │
+                     ▼
+  ┌───────────────────────────────────────┐
+  │ Output (Terminal with Rich or JSON)   │
+  └───────────────────────────────────────┘
+```
+
+### Evidence Rules & Signed Weights
+- **Fix commit in HEAD history** (`+3`): A commit referencing `#N` or `GH-N` is an ancestor of `HEAD`.
+- **Linked PR merged** (`+2`): A pull request linked to or closing issue `#N` was merged into the repository.
+- **Related files exist at HEAD** (`+2`): All files modified by the issue's commits/PRs still exist.
+- **No revert detected** (`+1`): The fix commit was not undone by a subsequent `git revert`.
+- **Related files deleted without replacement** (`-3`): Referenced files were deleted in git history and not renamed.
+- **Fix commit later reverted** (`-3`): Git's native revert trailer (`This reverts commit <sha>.`) indicates the fix was undone.
+
+### Confidence Score (Evidence Strength)
+
+Confidence is computed as an **evidence-strength heuristic** normalized and clamped to `[0.05, 0.98]`.
+
+```text
+Confidence = 0.50 + (sum(Weights) / (2 × MAX_ABS_WEIGHT))
+```
+> **Important Note:** Confidence is **NOT** a calibrated Bayesian probability. A confidence of 95% indicates an overwhelming accumulation of strong supporting evidence in the Git tree, not that the classification is statistically 95% likely to be correct.
+
+---
+
+## GitHub Authentication & Rate Limits
+
+GitRelevance works unauthenticated for public repositories out of the box.
+
+To analyze private repositories or avoid GitHub's unauthenticated API rate limits (60 requests/hour), supply a personal access token via the `GITHUB_TOKEN` environment variable or a local `.env` file:
+
+```bash
+export GITHUB_TOKEN="ghp_yourPersonalAccessTokenHere"
+gitrelevance analyze
+```
+
+---
+
+## Python API Usage
+
+GitRelevance can also be integrated directly into Python scripts:
+
+```python
+from gitrelevance.git.repository import GitRepository
+from gitrelevance.providers.github import GitHubProvider
+from gitrelevance.analysis.engine import AnalysisEngine
+from gitrelevance.output.terminal import TerminalRenderer
+from gitrelevance.output.json import to_json
+
+# 1. Initialize Git repository and GitHub provider
+repo = GitRepository(".")
+owner, repo_name = GitHubProvider.parse_remote(repo.remote_url("origin"))
+provider = GitHubProvider(owner=owner, repo=repo_name)
+
+# 2. Run analysis
+engine = AnalysisEngine(repo, provider)
+results = engine.analyze(state="open")
+
+# 3. Render results
+for result in results:
+    print(f"#{result.issue.number} {result.issue.title} -> {result.classification.value} ({result.confidence:.0%})")
+```
+
+---
+
+## Running Tests
+
+```bash
+# Run complete test suite
+pytest -v
+
+# Run individual test layers
+pytest tests/git/           # Git abstraction layer
+pytest tests/providers/     # Provider layer
+pytest tests/analysis/      # Evidence & classification unit tests
+pytest tests/output/        # Terminal & JSON rendering tests
+pytest tests/cli/           # Typer CLI tests
+pytest tests/scenarios/     # End-to-end repository scenarios
+```
+
+---
+
+## Adding a Scenario Test
+
+To add a new end-to-end scenario test:
+1. Create `tests/scenarios/test_scenario_<name>.py`.
+2. Import `FakeProvider`, `make_issue`, `make_pr`, and assertion helpers from `tests.scenarios.conftest`.
+3. Use `RepoBuilder` to construct a real temporary Git repository.
+4. Execute `AnalysisEngine(repo, provider).analyze()` and assert on the `AnalysisResult` fields.
+
+```python
+from gitrelevance.analysis.engine import AnalysisEngine
+from gitrelevance.git.repository import GitRepository
+from gitrelevance.models import Classification
+from tests.fixtures.repo_builder import RepoBuilder
+from tests.scenarios.conftest import FakeProvider, make_issue
+
+def test_my_custom_scenario():
+    builder = RepoBuilder().commit("Initial", files={"app.py": "code"})
+    path = builder.build()
+    try:
+        repo = GitRepository(path)
+        issue = make_issue(number=99, title="Custom issue", state="closed")
+        results = AnalysisEngine(repo, FakeProvider(issues=[issue])).analyze()
+        assert results[0].classification == Classification.UNKNOWN
+    finally:
+        builder.cleanup()
+```
+
+---
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

gitrelevance-0.1.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "gitrelevance"
+version = "0.1.0"
+description = "Analyze whether historical GitHub issues are still relevant to a codebase, using Git history as evidence"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    { name = "GitRelevance Contributors" },
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Version Control :: Git",
+]
+dependencies = [
+    "gitpython>=3.1.0",
+    "PyGithub>=2.0.0",
+    "diskcache>=5.6.0",
+    "python-dotenv>=1.0.0",
+    "typer>=0.9.0",
+    "rich>=13.0.0",
+    "typing_extensions; python_version < '3.11'",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "responses>=0.23.0",
+    "build>=1.0.0",
+    "twine>=5.0.0",
+]
+
+[project.scripts]
+gitrelevance = "gitrelevance.cli.commands:app"
+
+[project.urls]
+Homepage = "https://github.com/gitrelevance/gitrelevance"
+Repository = "https://github.com/gitrelevance/gitrelevance"
+Issues = "https://github.com/gitrelevance/gitrelevance/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/gitrelevance"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

gitrelevance-0.1.0/src/gitrelevance/__init__.py

@@ -0,0 +1,6 @@
+from gitrelevance.models import AnalysisResult, Classification, EvidenceItem
+
+__version__ = "0.1.0"
+
+__all__ = ["Classification", "EvidenceItem", "AnalysisResult"]
+

gitrelevance-0.1.0/src/gitrelevance/analysis/__init__.py

@@ -0,0 +1,20 @@
+from gitrelevance.analysis.classifier import classify
+from gitrelevance.analysis.confidence import compute_confidence
+from gitrelevance.analysis.current_state import CurrentStateFacts, analyze_current_state
+from gitrelevance.analysis.engine import AnalysisEngine
+from gitrelevance.analysis.evidence import collect_evidence
+from gitrelevance.analysis.matcher import MatchSet, build_all_match_sets, build_match_set
+
+__all__ = [
+    "MatchSet",
+    "build_match_set",
+    "build_all_match_sets",
+    "CurrentStateFacts",
+    "analyze_current_state",
+    "collect_evidence",
+    "compute_confidence",
+    "classify",
+    "AnalysisEngine",
+]
+
+