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.1.tar.gz (21.2 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.1-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chub_guard_init-1.1.1.tar.gz
  • Upload date:
  • Size: 21.2 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.1.tar.gz
Algorithm Hash digest
SHA256 7f67bbfd7798a7aea8d1b6d422416cce6c8a39cd440f666b54d4cc99baab8a16
MD5 ca7cd657a7e4c7f760e4ea5335109d9f
BLAKE2b-256 1044c5fc21a168e47b320e0b3d4f678dc2e957f5696663778a4dc880babb8d27

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chub_guard_init-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f00e983f3e6b5c8af0e24e1e1218c603e6266a3ee2adaa0aaf6d970b45ff6dcb
MD5 4fc085a6f7cf3cbc03d0ee228b6fff90
BLAKE2b-256 bb8d854fdd0a886c81352bf3e52fd7c640d45c953eb76ba1bcee0eccbd1cdb37

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