Skip to main content

One-command setup for chub_guard - the AI SDK deprecation linter

Project description

chub-guard-init (pip)

One command to set up chub_guard in any Python project.

Prerequisites

  • Python >= 3.10
  • pip or pipx
  • Node.js/npm (for documentation engine)
  • 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 (Project-wide scan & report)

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

This generates a detailed chub_guard_report.md in your root directory.

This will:

  • Auto-install @aisuite/chub documentation engine via npm.
  • 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

The guard will now run automatically on every git commit.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chub_guard_init-1.1.11.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chub_guard_init-1.1.11-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file chub_guard_init-1.1.11.tar.gz.

File metadata

  • Download URL: chub_guard_init-1.1.11.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for chub_guard_init-1.1.11.tar.gz
Algorithm Hash digest
SHA256 42d8e01ac3a2cfff8e9458de4559c8874392f9d447a5efa32d7f6c32c5fe189d
MD5 6a81c42d8ac5cea1da70a13a0b464060
BLAKE2b-256 3dd0b60e16ef2ae384475ff8f086084aa0f4fc6674bedced5acf95b70a86ed58

See more details on using hashes here.

File details

Details for the file chub_guard_init-1.1.11-py3-none-any.whl.

File metadata

File hashes

Hashes for chub_guard_init-1.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 3cf213fc673e450a5e3644532de5af1c77192397a7900c86318442925e94f814
MD5 b5a654943d7ecea94ac017b1e4c72dd1
BLAKE2b-256 20003f7353534b9aa50218b0194115f0aaed305087d02b361fcec738cc965206

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page