chub-guard-init 1.0.0__tar.gz

chub_guard_init-1.0.0/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: chub-guard-init
+Version: 1.0.0
+Summary: One-command setup for chub_guard — the AI SDK deprecation linter
+Requires-Python: >=3.10

chub_guard_init-1.0.0/README.md

@@ -0,0 +1,52 @@
+# chub-guard-init (pip)
+
+One command to set up [chub_guard](https://github.com/rhealaloo45/chub-guard)
+in any Python project.
+
+## Prerequisites
+
+- Python >= 3.10
+- pip or pipx
+- git
+
+## Usage
+
+### Option 1 — pipx (recommended, no permanent install)
+
+    pipx run chub-guard-init
+
+### Option 2 — pip
+
+    pip install chub-guard-init
+    chub-guard-init
+
+This will:
+- Copy `chub_guard.py` into `scripts/`
+- Write `.pre-commit-config.yaml`
+- Write `.chub-docs/registry.json`
+- Update `.gitignore` to ignore doc caches
+- Run `pre-commit install` automatically
+
+## After Setup
+
+Install chub so the guard can fetch live docs:
+
+    npm install -g @aisuite/chub
+
+Make a commit to test it:
+
+    git commit -m "test"
+
+## Suppressing False Positives
+
+Add `# noqa: UP035` to any line to skip:
+
+    import google.generativeai as genai  # noqa: UP035
+
+## Also available via npm
+
+    npx chub-guard-init
+
+## Part of chub-guard
+
+Full docs: https://github.com/rhealaloo45/chub-guard

chub_guard_init-1.0.0/chub_guard_init/__init__.py

@@ -0,0 +1 @@
+

chub_guard_init-1.0.0/chub_guard_init/main.py

@@ -0,0 +1,108 @@
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
+# Resolve paths to source files in the repo
+PACKAGE_DIR = Path(__file__).parent
+REPO_ROOT   = PACKAGE_DIR.parent.parent
+
+CHUB_GUARD_PY   = (REPO_ROOT / "scripts" / "chub_guard.py").read_text(encoding="utf-8")
+PRE_COMMIT_YAML = (REPO_ROOT / ".pre-commit-config.yaml").read_text(encoding="utf-8")
+REGISTRY_JSON   = (REPO_ROOT / ".chub-docs" / "registry.json").read_text(encoding="utf-8")
+
+
+def is_pre_commit_installed() -> bool:
+    return shutil.which("pre-commit") is not None
+
+
+def is_git_repo(cwd: Path) -> bool:
+    return (cwd / ".git").exists()
+
+
+def ask(question: str) -> str:
+    try:
+        return input(question).strip().lower()
+    except (EOFError, KeyboardInterrupt):
+        return "n"
+
+
+def safe_write(file_path: Path, content: str, label: str) -> None:
+    if file_path.exists():
+        answer = ask(f"⚠ {label} already exists. Overwrite? (y/n): ")
+        if answer != "y":
+            print(f"  skipped {label}")
+            return
+    try:
+        file_path.write_text(content, encoding="utf-8")
+        print(f"✓ {label}")
+    except Exception as e:
+        print(f"✗ Failed to write {label}: {e}")
+
+
+def main() -> None:
+    cwd = Path.cwd()
+
+    print("")
+    print("chub-guard-init")
+    print("───────────────────────────────────────")
+    print("Setting up chub_guard in this project...")
+    print("")
+
+    # 1. Create directories
+    (cwd / "scripts").mkdir(parents=True, exist_ok=True)
+    (cwd / ".chub-docs").mkdir(parents=True, exist_ok=True)
+
+    # 2. Write files
+    safe_write(cwd / "scripts" / "chub_guard.py",      CHUB_GUARD_PY,   "scripts/chub_guard.py")
+    safe_write(cwd / ".pre-commit-config.yaml",         PRE_COMMIT_YAML, ".pre-commit-config.yaml")
+    safe_write(cwd / ".chub-docs" / "registry.json",   REGISTRY_JSON,   ".chub-docs/registry.json")
+
+    # 3. Update .gitignore
+    gitignore_path = cwd / ".gitignore"
+    gitignore_entry = ".chub-docs/*.md"
+    if gitignore_path.exists():
+        content = gitignore_path.read_text(encoding="utf-8")
+        if gitignore_entry not in content:
+            gitignore_path.write_text(content.rstrip() + f"\n{gitignore_entry}\n", encoding="utf-8")
+            print("✓ .gitignore updated")
+    else:
+        gitignore_path.write_text(f"{gitignore_entry}\n", encoding="utf-8")
+        print("✓ .gitignore created")
+
+    print("")
+
+    # 4. Check for git repo
+    if not is_git_repo(cwd):
+        print("⚠ No .git directory found.")
+        print("  Run git init first, then: pre-commit install")
+        print("")
+        sys.exit(0)
+
+    # 5. Run pre-commit install
+    if is_pre_commit_installed():
+        try:
+            subprocess.run(["pre-commit", "install"], cwd=cwd, check=True)
+            print("")
+            print("✓ pre-commit hook installed")
+            print("")
+            print("───────────────────────────────────────")
+            print("Done! chub_guard will now run on every commit.")
+            print("")
+            print("Next steps:")
+            print("  1. Install chub:  npm install -g @aisuite/chub")
+            print("  2. Make a commit to test the guard")
+            print("")
+        except subprocess.CalledProcessError:
+            print("⚠ pre-commit install failed. Run manually: pre-commit install")
+    else:
+        print("⚠ pre-commit not found. To finish setup:")
+        print("")
+        print("  pip install pre-commit")
+        print("  pre-commit install")
+        print("")
+        print("Then install chub: npm install -g @aisuite/chub")
+
+
+if __name__ == "__main__":
+    main()

chub_guard_init-1.0.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "chub-guard-init"
+version = "1.0.0"
+description = "One-command setup for chub_guard — the AI SDK deprecation linter"
+requires-python = ">=3.10"
+dependencies = []
+
+[project.scripts]
+chub-guard-init = "chub_guard_init.main:main"
+
+[tool.hatch.build.targets.wheel]
+include = [
+  "chub_guard_init/",
+  "../../scripts/chub_guard.py",
+  "../../.pre-commit-config.yaml",
+  "../../.chub-docs/registry.json"
+]