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.10.tar.gz (22.1 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.10-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chub_guard_init-1.1.10.tar.gz
  • Upload date:
  • Size: 22.1 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.10.tar.gz
Algorithm Hash digest
SHA256 a97d0d968be4b947ad25f20c0bd58a353554045ac506c2c0cb407bf54b43b4a3
MD5 fddd6166e0796609e5402b21e35cbaf4
BLAKE2b-256 61cb99258bd2fd2e51d0bafb4e59232a01da06a8973f7fd981cbf9bce98f85b3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chub_guard_init-1.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 ab135a923095a6f5affdfac7b5f5cdf42f22341188f98681406515882da1e740
MD5 61b7e6da1fab2bbb1f4d4685924ea1ba
BLAKE2b-256 350ad5ed5d4929a99f1d420db1c599ce8ab3efce098be8c70417edf0421d9082

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