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.2.tar.gz (21.4 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.2-py3-none-any.whl (23.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chub_guard_init-1.1.2.tar.gz
  • Upload date:
  • Size: 21.4 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.2.tar.gz
Algorithm Hash digest
SHA256 54046520304326d38ae60b85fc69d6a87839c8e0582f159755b612c99de767da
MD5 c01aa4ff75c29af2f02aa1cc2ab98ed6
BLAKE2b-256 d45d18cfc2c3d598dec587e88f22e94518e732ea2ad8edc61b111f5cf5519f3d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chub_guard_init-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 457d060dca615ffcf3c1b56f9ee30384f6006a02464db342d43a1161c22c455a
MD5 b15c1d3f5056c94cadf727a1930067d2
BLAKE2b-256 247eb127835631ff1aa5df9f96f19b634d688b2c61e567fa1fffc0fe3cefc160

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