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.5.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.5-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chub_guard_init-1.1.5.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.5.tar.gz
Algorithm Hash digest
SHA256 12441bc8e0ec617cc550258a2f8b71db70bde90c7eec047202a8c3c36e97a846
MD5 2e8bb55012ab032d13e3aed7852bd195
BLAKE2b-256 99a8f1eb95475eb2a9558fb02bc69ea396f4622f1f9f30d760a1bc0b63655757

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chub_guard_init-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4c2ee66244c8c45dd9863e71ed42862816a9d7806f9c135d8a68dcdbcbb9a886
MD5 64ea9576485305a74383997bf253d2e7
BLAKE2b-256 5f74978ac051b975f951f73abb81b955dd9325a7790e8f28fd2cb92f115b6e0d

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