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

Uploaded Python 3

File details

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

File metadata

  • Download URL: chub_guard_init-1.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 c889e4478ab7a8f4c0a54079f8105b74378519e972839713bae140d6cee3f055
MD5 2636f7eca471ba9be78508eee213e22e
BLAKE2b-256 0addf7cac396522d99f5ccdb95350f07ebd1c47fd355741c9decfa7b78de8752

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chub_guard_init-1.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 db434f3c20235be153eb1d9ab42048e086032696e06b62aca732f8d21eed8a81
MD5 27cb8b4b31afccb810346b98db817736
BLAKE2b-256 be7f5f131c80e3518398b128790d9dd1e7e3da14692a17f76f5550b860e2b908

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