Skip to main content

One-command setup for chub_guard - the AI SDK deprecation linter

Project description

🛡️ chub-guard-init (v1.2.1)

The Universal Deprecation Guard for modern engineering teams.

PyPI version License: MIT

📖 The Problem

Modern development moves fast. AI coding assistants often suggest deprecated APIs, and browser automation tools (Selenium, Playwright) change their signatures frequently. Standard linters miss these semantic deprecations, leading to production bugs and technical debt.

🚀 The Solution

chub-guard-init is the official one-command setup for chub-guard. It installs a specialized git-hook that blocks deprecated patterns—from AI SDKs and Automation to Legacy Python—before they ever reach your codebase by syncing with live documentation.


🏎️ Usage

Option 1: pipx (Recommended)

Run this command once at the root of any project:

pipx run chub-guard-init

Option 2: Standard pip

pip install chub-guard-init
chub-guard-init

Run on demand (Universal Scan)

Run a full project scan at any time to generate a detailed report:

chub-guard-init run-all

This generates a chub_guard_report.md with recommended fixes, trend lines, and Agent-ready prompts.


✨ Key Features

1. Hybrid Analysis (Resilient Engine)

Unlike standard linters that fail on syntax errors, chub-guard uses a Resilient Regex Engine. It will still detect critical automation and SDK deprecations even in files with Python 2/3 conflicts or broken refactors.

2. Polyglot Support

A single tool to guard your entire polyglot stack:

  • 🐍 Python: Advanced AST analysis for context managers and keyword arguments.
  • 🟨 JavaScript/TypeScript: Support for import, require, and React/Angular scoping.
  • Java: Package-level import detection.
  • ⚙️ C/C++: Header-based deprecation matching.

3. Rich Markdown Reporting

Generates a chub_guard_report.md featuring:

  • 📈 Trend Tracking: See if your technical debt is increasing or decreasing over time.
  • 🤖 Agent-Ready Prompts: Copy-paste prompts designed to let your AI Assistant (Cursor/Gemini) fix all issues in one go.
  • 💡 Embedded Fixes: Exact code blocks for modern replacements, extracted directly from official docs.

4. Community-Powered Intelligence

  • Live Docs: Fetches the latest migration guides from Andrew Ng's context-hub.
  • Global Sync: Automatically stays updated with the latest community-contributed patterns from GitHub.

🧠 What does it guard?

  • 🤖 AI SDKs: Catches breaking changes in OpenAI, Gemini, Anthropic, Langchain.
  • 🌐 Browser Automation: Detects deprecated Selenium (find_element_by_id) and Playwright patterns.
  • 🐍 Legacy Code: Identifies Python 2 syntax and legacy urllib2/xrange.
  • 🏗️ Framework Smells: Detects architectural misconfigurations (e.g. React/Angular mixing).
  • ✨ Dynamic Docs: Automatically flags any pattern marked as "deprecated" in official documentation fetched via Context-Hub.

🏁 After Setup

Every time you git commit, the guard will scan your changed files. If it finds a deprecated pattern, it will block the commit and provide a rich terminal guide extracted directly from official docs.


⚙️ Configuration

Suppressing False Positives

Append # noqa: CHUB to any line:

import google.generativeai as genai  # noqa: CHUB

Syncing with the Ecosystem

Keep your project in sync with the latest ecosystem rules:

python scripts/chub_guard.py update-registry

🤝 Credits

Part of the chub-guard ecosystem, powered by Andrew Ng’s context-hub.

Full Documentation: github.com/rhealaloo45/chub-guard


📄 License

MIT © Rhea Laloo

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.2.1.tar.gz (23.9 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.2.1-py3-none-any.whl (26.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chub_guard_init-1.2.1.tar.gz
  • Upload date:
  • Size: 23.9 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.2.1.tar.gz
Algorithm Hash digest
SHA256 9d16f3be780e6bba220569d4ed19042cd298798be67f39cc12e4d3ba64f0987a
MD5 4e9c310fd5c8cab81a0ad3303c51eafe
BLAKE2b-256 97b678ca7aa72a730e4b8de23e31cf62c9b6ef4a8f4ec1333fb98c7a477df41d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for chub_guard_init-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 452e70ce8c510f4ef0b083cfa1f69110aa5b4a98b9fe02840ee7a3fe1041f2d3
MD5 9deb20edcfd778513d88c6803ec0f692
BLAKE2b-256 729c53a08ed0e8c72cf026241b1ce3c8c6d8190e8cce7b8fe9e064a803e57082

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