repofail 0.2.3__tar.gz → 0.2.5__tar.gz

repofail-0.2.5/.gitignore

@@ -0,0 +1,22 @@
+dist/
+__pycache__/
+*.pyc
+.pytest_cache/
+*.egg-info/
+.eggs/
+.venv/
+.venv-check/
+venv/
+testenv/
+VISION.md
+repofail-contract.json
+
+# Sensitive / local-only (never commit)
+.env
+.env.local
+.env.*.local
+.secrets
+secrets.yaml
+.credentials
+*.pem
+.DS_Store

{repofail-0.2.3 → repofail-0.2.5}/Formula/repofail.rb

@@ -1,18 +1,20 @@
 # Homebrew formula for repofail
 # To use: copy to your tap repo (e.g. homebrew-tap/Formula/repofail.rb)
-# Then: brew tap jayvenn21/tap && brew install repofail
-# Or: brew install --formula Formula/repofail.rb (from this repo)
+# Then: brew tap jayvenn21/tap && brew install jayvenn21/tap/repofail
 #
 # Homebrew uses --no-deps when installing the main package, so all Python
 # dependencies must be declared as resources below.
+# If SHA256 fails after pushing a new tag, get the correct hash with:
+#   curl -sL https://github.com/jayvenn21/repofail/archive/refs/tags/vX.Y.Z.tar.gz | shasum -a 256
 
 class Repofail < Formula
   include Language::Python::Virtualenv
 
   desc "Deterministic runtime compatibility analyzer"
   homepage "https://github.com/jayvenn21/repofail"
-  url "https://github.com/jayvenn21/repofail/archive/refs/tags/v0.2.2.tar.gz"
-  sha256 "331055c40ec70a9ffb4f14f801bddf519014aaff1db1e5c0955b2f35e46da219"
+  url "https://github.com/jayvenn21/repofail/archive/refs/tags/v0.2.5.tar.gz"
+  # Replace with v0.2.5 tarball SHA after tagging: curl -sL https://github.com/jayvenn21/repofail/archive/refs/tags/v0.2.5.tar.gz | shasum -a 256
+  sha256 "d5558cd419c8d46bdc958064cb97f963d1ea793866414c025906ec15033512ed"
   license "MIT"
 
   # App supports Python 3.10+. We use 3.12 for current Homebrew; change to

repofail-0.2.3/README.md → repofail-0.2.5/PKG-INFO

@@ -1,5 +1,24 @@
+Metadata-Version: 2.4
+Name: repofail
+Version: 0.2.5
+Summary: Predict why a repository will fail on your machine before you run it.
+Author: Jayanth
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.10
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Requires-Dist: typer>=0.9.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
 <p align="center">
-  <img src="https://raw.githubusercontent.com/jayvenn21/repofail/v0.2.2/docs/logo.png" width="180" alt="repofail logo">
+  <img src="https://raw.githubusercontent.com/jayvenn21/repofail/main/docs/logo.png" width="180" alt="repofail logo">
 </p>
 
 <h1 align="center">repofail</h1>
@@ -9,14 +28,16 @@
 </p>
 
 <p align="center">
-  <a href="https://pypi.org/project/repofail/"><img src="https://img.shields.io/pypi/v/repofail?cacheSeconds=60&cacheBust=1"></a>
-  <img src="https://img.shields.io/badge/ci-passing-brightgreen">
-  <img src="https://img.shields.io/badge/python-3.10+-blue">
-  <img src="https://img.shields.io/badge/runtime-validated-success">
-  <img src="https://img.shields.io/badge/rules-20+-informational">
+  <a href="https://pypi.org/project/repofail/"><img src="https://img.shields.io/pypi/v/repofail" alt="PyPI"></a>
+  <a href="https://pypi.org/project/repofail/"><img src="https://img.shields.io/pypi/pyversions/repofail" alt="Python"></a>
+  <a href="https://pypi.org/project/repofail/"><img src="https://img.shields.io/pypi/dm/repofail" alt="Downloads"></a>
+  <a href="https://github.com/jayvenn21/repofail/actions"><img src="https://img.shields.io/github/actions/workflow/status/jayvenn21/repofail/repofail.yml?branch=main" alt="CI"></a>
+  <img src="https://img.shields.io/badge/runtime-validated-brightgreen" alt="Runtime">
+  <img src="https://img.shields.io/badge/rules-20%2B-blue" alt="Rules">
 </p>
 
 <p align="center">
+  <strong>The static analyzer for runtime compatibility.</strong><br>
   Predict why a repository will fail on your machine before you run it.
 </p>
 
@@ -33,11 +54,24 @@
   <a href="#usage">Usage</a> ·
   <a href="#rules">Rules</a> ·
   <a href="#ci-integration">CI</a> ·
-  <a href="#contracts">Contracts</a>
+  <a href="#contracts">Contracts</a> ·
+  <a href="#faq">FAQ</a>
 </p>
 
 ---
 
+## Quickstart (30 seconds)
+
+```bash
+pip install repofail
+cd /path/to/any/repo
+repofail
+```
+
+You get a compatibility score and a list of deterministic blockers (Node version, Python range, CUDA, lock file, spec drift, etc.). No install of the repo’s dependencies. No cloud. No AI.
+
+---
+
 ## Why This Exists
 
 Most tools install dependencies.
@@ -70,13 +104,25 @@ Run it against any local clone.
 ## Example output
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/jayvenn21/repofail/v0.2.2/docs/screenshots/nodefail.gif" width="850" alt="Node engine mismatch demo">
+  <img src="https://raw.githubusercontent.com/jayvenn21/repofail/main/docs/screenshots/nodefail.gif" width="850" alt="Node engine mismatch demo">
 </p>
 
 Deterministic spec violation detected — engines.node requires 22.x, host is 20.x.
 
 ---
 
+## Case studies
+
+| Scenario | Without repofail | With repofail |
+|----------|------------------|----------------|
+| **Node engine mismatch** | Clone → `npm install` → `EBADENGINE` → search, fix, retry | `repofail .` → "Node 22.x required, host is 20.x" + suggested fix in &lt;1s |
+| **CUDA on laptop** | Clone → `pip install` → run → `RuntimeError: CUDA unavailable` | `repofail .` → "Hard-coded CUDA path, host has no GPU" before you run |
+| **Spec drift (Python)** | CI passes, local fails; pyproject says 3.11, Docker uses 3.9 | `repofail .` → "Spec drift — 3 distinct Python targets" + where they differ |
+
+Try the demos: [node engine](https://github.com/jayvenn21/repofail-demo-node-engine), [spec drift](https://github.com/jayvenn21/repofail-demo-spec-drift), [CUDA hardcoded](https://github.com/jayvenn21/repofail-demo-cuda-hardcoded).
+
+---
+
 ## Install
 
 **From PyPI (recommended)**
@@ -85,12 +131,25 @@ Deterministic spec violation detected — engines.node requires 22.x, host is 20
 pip install repofail
 ```
 
-Or with pipx (isolated CLI install):
+**One-liner (curl)**
+
+```bash
+curl -sSL https://raw.githubusercontent.com/jayvenn21/repofail/main/install.sh | bash
+```
+
+**pipx (isolated CLI)**
 
 ```bash
 pipx install repofail
 ```
 
+**Homebrew** (formula: [jayvenn21/homebrew-tap](https://github.com/jayvenn21/homebrew-tap))
+
+```bash
+brew tap jayvenn21/tap
+brew install jayvenn21/tap/repofail
+```
+
 **From source (development)**
 
 ```bash
@@ -139,6 +198,31 @@ repofail s -j               # Stats with JSON output
 
 ## CI integration
 
+**Option A — Reusable action (comment on PR + fail CI)**
+
+```yaml
+name: repofail
+on:
+  pull_request:
+    branches: [main, master]
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jayvenn21/repofail/.github/actions/repofail@main
+        with:
+          path: .
+          fail_on: HIGH
+          comment: 'true'
+          upload_artifact: 'true'
+          pr_number: ${{ github.event.pull_request.number }}
+```
+
+The action installs repofail, runs a compatibility check, comments the Markdown report on the PR, uploads the JSON artifact, and fails the job if violations meet the threshold.
+
+**Option B — Inline (no comment)**
+
 ```yaml
 - uses: actions/checkout@v4
 - uses: actions/setup-python@v5
@@ -157,7 +241,7 @@ repofail gen . -o contract.json
 repofail check contract.json
 ```
 
-Versioned runtime expectations. Teams share contracts. CI checks drift.
+Versioned runtime expectations. Teams share contracts. CI checks drift. Generated contracts report the installed repofail version (from PyPI/Homebrew) so tooling stays traceable.
 
 ---
 
@@ -230,8 +314,39 @@ Extensible via `.repofail/rules.yaml`.
 
 ---
 
+## FAQ
+
+**Does repofail install or run my project?**  
+No. It only reads configs and (optionally) inspects Python/JS for patterns. No `pip install`, no `npm install`, no execution.
+
+**Does it need the internet?**  
+No. It runs fully offline. Host inspection uses local subprocesses (e.g. `node --version`).
+
+**Why “deterministic”?**  
+Same repo + same host → same result. No ML, no heuristics that change between runs. Rules are based on config and code.
+
+**Can I add my own rules?**  
+Yes. Put a `.repofail/rules.yaml` (or `repofail-rules.yaml`) in the repo and define conditions on `repo.*` and `host.*`. See `repofail -e list` for built-in rule IDs.
+
+**What if my repo is clean?**  
+You get a high score (e.g. 96–100%) and “No deterministic blockers detected.” repofail does not invent problems.
+
+---
+
+## When not to use it
+
+- **You need dependency resolution** — use pip, npm, poetry, etc. repofail does not install or resolve.
+- **You need security scanning** — use Dependabot, Snyk, or similar. repofail is compatibility-only.
+- **You want “AI suggested fixes”** — repofail gives deterministic, rule-based suggestions only.
+- **You run only in one environment** — if every dev and CI use the same OS/runtime, the value is smaller (still useful for drift and contracts).
+
+---
+
 ## Testing
 
 ```bash
+pip install -e ".[dev]"
 pytest tests/ -v
 ```
+
+**Quick checks:** `bash -n install.sh` (syntax). The GitHub Action runs on every PR in this repo (see [.github/workflows/repofail.yml](.github/workflows/repofail.yml)); to test the reusable action, use it in another repo’s workflow on a PR.

repofail-0.2.3/PKG-INFO → repofail-0.2.5/README.md

@@ -1,18 +1,5 @@
-Metadata-Version: 2.4
-Name: repofail
-Version: 0.2.3
-Summary: Predict why a repository will fail on your machine before you run it.
-Author: Jayanth
-Requires-Python: >=3.10
-Requires-Dist: pyyaml>=6.0
-Requires-Dist: tomli>=2.0; python_version < '3.11'
-Requires-Dist: typer>=0.9.0
-Provides-Extra: dev
-Requires-Dist: pytest>=7.0; extra == 'dev'
-Description-Content-Type: text/markdown
-
 <p align="center">
-  <img src="https://raw.githubusercontent.com/jayvenn21/repofail/v0.2.2/docs/logo.png" width="180" alt="repofail logo">
+  <img src="https://raw.githubusercontent.com/jayvenn21/repofail/main/docs/logo.png" width="180" alt="repofail logo">
 </p>
 
 <h1 align="center">repofail</h1>
@@ -22,14 +9,16 @@ Description-Content-Type: text/markdown
 </p>
 
 <p align="center">
-  <a href="https://pypi.org/project/repofail/"><img src="https://img.shields.io/pypi/v/repofail?cacheSeconds=60&cacheBust=1"></a>
-  <img src="https://img.shields.io/badge/ci-passing-brightgreen">
-  <img src="https://img.shields.io/badge/python-3.10+-blue">
-  <img src="https://img.shields.io/badge/runtime-validated-success">
-  <img src="https://img.shields.io/badge/rules-20+-informational">
+  <a href="https://pypi.org/project/repofail/"><img src="https://img.shields.io/pypi/v/repofail" alt="PyPI"></a>
+  <a href="https://pypi.org/project/repofail/"><img src="https://img.shields.io/pypi/pyversions/repofail" alt="Python"></a>
+  <a href="https://pypi.org/project/repofail/"><img src="https://img.shields.io/pypi/dm/repofail" alt="Downloads"></a>
+  <a href="https://github.com/jayvenn21/repofail/actions"><img src="https://img.shields.io/github/actions/workflow/status/jayvenn21/repofail/repofail.yml?branch=main" alt="CI"></a>
+  <img src="https://img.shields.io/badge/runtime-validated-brightgreen" alt="Runtime">
+  <img src="https://img.shields.io/badge/rules-20%2B-blue" alt="Rules">
 </p>
 
 <p align="center">
+  <strong>The static analyzer for runtime compatibility.</strong><br>
   Predict why a repository will fail on your machine before you run it.
 </p>
 
@@ -46,11 +35,24 @@ Description-Content-Type: text/markdown
   <a href="#usage">Usage</a> ·
   <a href="#rules">Rules</a> ·
   <a href="#ci-integration">CI</a> ·
-  <a href="#contracts">Contracts</a>
+  <a href="#contracts">Contracts</a> ·
+  <a href="#faq">FAQ</a>
 </p>
 
 ---
 
+## Quickstart (30 seconds)
+
+```bash
+pip install repofail
+cd /path/to/any/repo
+repofail
+```
+
+You get a compatibility score and a list of deterministic blockers (Node version, Python range, CUDA, lock file, spec drift, etc.). No install of the repo’s dependencies. No cloud. No AI.
+
+---
+
 ## Why This Exists
 
 Most tools install dependencies.
@@ -83,13 +85,25 @@ Run it against any local clone.
 ## Example output
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/jayvenn21/repofail/v0.2.2/docs/screenshots/nodefail.gif" width="850" alt="Node engine mismatch demo">
+  <img src="https://raw.githubusercontent.com/jayvenn21/repofail/main/docs/screenshots/nodefail.gif" width="850" alt="Node engine mismatch demo">
 </p>
 
 Deterministic spec violation detected — engines.node requires 22.x, host is 20.x.
 
 ---
 
+## Case studies
+
+| Scenario | Without repofail | With repofail |
+|----------|------------------|----------------|
+| **Node engine mismatch** | Clone → `npm install` → `EBADENGINE` → search, fix, retry | `repofail .` → "Node 22.x required, host is 20.x" + suggested fix in &lt;1s |
+| **CUDA on laptop** | Clone → `pip install` → run → `RuntimeError: CUDA unavailable` | `repofail .` → "Hard-coded CUDA path, host has no GPU" before you run |
+| **Spec drift (Python)** | CI passes, local fails; pyproject says 3.11, Docker uses 3.9 | `repofail .` → "Spec drift — 3 distinct Python targets" + where they differ |
+
+Try the demos: [node engine](https://github.com/jayvenn21/repofail-demo-node-engine), [spec drift](https://github.com/jayvenn21/repofail-demo-spec-drift), [CUDA hardcoded](https://github.com/jayvenn21/repofail-demo-cuda-hardcoded).
+
+---
+
 ## Install
 
 **From PyPI (recommended)**
@@ -98,12 +112,25 @@ Deterministic spec violation detected — engines.node requires 22.x, host is 20
 pip install repofail
 ```
 
-Or with pipx (isolated CLI install):
+**One-liner (curl)**
+
+```bash
+curl -sSL https://raw.githubusercontent.com/jayvenn21/repofail/main/install.sh | bash
+```
+
+**pipx (isolated CLI)**
 
 ```bash
 pipx install repofail
 ```
 
+**Homebrew** (formula: [jayvenn21/homebrew-tap](https://github.com/jayvenn21/homebrew-tap))
+
+```bash
+brew tap jayvenn21/tap
+brew install jayvenn21/tap/repofail
+```
+
 **From source (development)**
 
 ```bash
@@ -152,6 +179,31 @@ repofail s -j               # Stats with JSON output
 
 ## CI integration
 
+**Option A — Reusable action (comment on PR + fail CI)**
+
+```yaml
+name: repofail
+on:
+  pull_request:
+    branches: [main, master]
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jayvenn21/repofail/.github/actions/repofail@main
+        with:
+          path: .
+          fail_on: HIGH
+          comment: 'true'
+          upload_artifact: 'true'
+          pr_number: ${{ github.event.pull_request.number }}
+```
+
+The action installs repofail, runs a compatibility check, comments the Markdown report on the PR, uploads the JSON artifact, and fails the job if violations meet the threshold.
+
+**Option B — Inline (no comment)**
+
 ```yaml
 - uses: actions/checkout@v4
 - uses: actions/setup-python@v5
@@ -170,7 +222,7 @@ repofail gen . -o contract.json
 repofail check contract.json
 ```
 
-Versioned runtime expectations. Teams share contracts. CI checks drift.
+Versioned runtime expectations. Teams share contracts. CI checks drift. Generated contracts report the installed repofail version (from PyPI/Homebrew) so tooling stays traceable.
 
 ---
 
@@ -243,8 +295,39 @@ Extensible via `.repofail/rules.yaml`.
 
 ---
 
+## FAQ
+
+**Does repofail install or run my project?**  
+No. It only reads configs and (optionally) inspects Python/JS for patterns. No `pip install`, no `npm install`, no execution.
+
+**Does it need the internet?**  
+No. It runs fully offline. Host inspection uses local subprocesses (e.g. `node --version`).
+
+**Why “deterministic”?**  
+Same repo + same host → same result. No ML, no heuristics that change between runs. Rules are based on config and code.
+
+**Can I add my own rules?**  
+Yes. Put a `.repofail/rules.yaml` (or `repofail-rules.yaml`) in the repo and define conditions on `repo.*` and `host.*`. See `repofail -e list` for built-in rule IDs.
+
+**What if my repo is clean?**  
+You get a high score (e.g. 96–100%) and “No deterministic blockers detected.” repofail does not invent problems.
+
+---
+
+## When not to use it
+
+- **You need dependency resolution** — use pip, npm, poetry, etc. repofail does not install or resolve.
+- **You need security scanning** — use Dependabot, Snyk, or similar. repofail is compatibility-only.
+- **You want “AI suggested fixes”** — repofail gives deterministic, rule-based suggestions only.
+- **You run only in one environment** — if every dev and CI use the same OS/runtime, the value is smaller (still useful for drift and contracts).
+
+---
+
 ## Testing
 
 ```bash
+pip install -e ".[dev]"
 pytest tests/ -v
 ```
+
+**Quick checks:** `bash -n install.sh` (syntax). The GitHub Action runs on every PR in this repo (see [.github/workflows/repofail.yml](.github/workflows/repofail.yml)); to test the reusable action, use it in another repo’s workflow on a PR.

{repofail-0.2.3 → repofail-0.2.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "repofail"
-version = "0.2.3"
+version = "0.2.5"
 description = "Predict why a repository will fail on your machine before you run it."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -14,6 +14,14 @@ dependencies = [
     "tomli>=2.0; python_version < '3.11'",
     "pyyaml>=6.0",
 ]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
+]
 
 [project.scripts]
 repofail = "repofail.cli:_main"
@@ -23,3 +31,6 @@ dev = [
     "pytest>=7.0",
 ]
 
+[tool.hatch.build.targets.sdist]
+exclude = [".venv-check", ".venv-check/**", "testenv", "testenv/**", ".venv", ".venv/**", "venv", "venv/**"]
+

repofail-0.2.5/repofail/__init__.py

@@ -0,0 +1,8 @@
+"""repofail — Failure-oriented repo introspection."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("repofail")
+except PackageNotFoundError:
+    __version__ = "0.0.0.dev0"

repofail-0.2.3/.gitignore

@@ -1,8 +0,0 @@
-dist/
-__pycache__/
-*.pyc
-.pytest_cache/
-*.egg-info/
-.eggs/
-VISION.md
-repofail-contract.json

repofail-0.2.3/repofail/__init__.py

@@ -1,3 +0,0 @@
-"""repofail — Failure-oriented repo introspection."""
-
-__version__ = "0.1.0"