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
  • 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 (entire project)

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

This will:

  • 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

Install chub so the guard can fetch live docs:

npm install -g @aisuite/chub

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.0.tar.gz (21.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.0-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chub_guard_init-1.1.0.tar.gz
  • Upload date:
  • Size: 21.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.0.tar.gz
Algorithm Hash digest
SHA256 3120f81a44bf2a6be0d9a8f7fec87f6050469701154144e988bdbe1f607837e0
MD5 d04de16f9233ab23903db7c0ba12c9df
BLAKE2b-256 0c79bf7d55b9125f69f224a75615c045cb7af67677c62a959d1a0bc2b53a0b4d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chub_guard_init-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 10b9ed2a71b8fbe6f26977a43fa959d3d61db88a7043ecafff1889cc0ba0e7f1
MD5 fb7d8324bf562202bc5a9e8c4753cae5
BLAKE2b-256 77e81e0558cf94555c9b7ced1a43e800c006090733ea63e8995c46a1cb9b4eed

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