Metadata-Version: 2.4
Name: chub-guard-init
Version: 1.1.1
Summary: One-command setup for chub_guard - the AI SDK deprecation linter
Author: Rhea Laloo
License-Expression: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# 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

### Run on demand (entire project)

    pipx run chub-guard-init run-all
    # or
    chub-guard-init run-all

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
- Enable zero-intervention telemetry to sync new AI deprecations globally

## 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: CHUB` (or `// noqa: CHUB` for JS/C/Java) to any line to skip:

    import google.generativeai as genai  # noqa: CHUB

## Also available via npm

    npx chub-guard-init

## Part of chub-guard

Full docs: https://github.com/rhealaloo45/chub-guard
