Skip to main content

AI-powered codebase health scanner

Project description

PyPI Python 3.9+ License: MIT PRs Welcome

🩺 Vett — AI-Powered Codebase Health Scanner

Fast codebase health checks with optional AI analysis. Local-first, open source, and developer-friendly.

✨ Features

  • 🔐 Security pattern detection (secrets, risky APIs)
  • 📏 Complexity and maintainability checks
  • 📝 TODO/FIXME/HACK discovery
  • 🤖 Optional AI project analysis (Anthropic, OpenAI, Gemini, OpenRouter)
  • 📄 Markdown report output (vett_report.md)

📦 Install

pip install -U vett

If you are developing locally:

pip install -e .

🚀 Quick Start

# Scan current project (interactive mode if no API key is set)
vett scan .

# Scan without AI
vett scan . --no-ai

# Scan a specific folder
vett scan ./my-project

API key setup (optional):

# Anthropic
export ANTHROPIC_API_KEY=your-key-here        # Mac/Linux
set ANTHROPIC_API_KEY=your-key-here           # Windows CMD
$env:ANTHROPIC_API_KEY="your-key-here"        # PowerShell

# OpenAI
export OPENAI_API_KEY=your-key-here

# Gemini
export GEMINI_API_KEY=your-key-here

# OpenRouter (great for free/open models)
export OPENROUTER_API_KEY=your-key-here

Pick provider with:

vett scan . --provider anthropic
vett scan . --provider openai
vett scan . --provider gemini
vett scan . --provider openrouter

🧭 CLI Reference

vett --help
vett scan --help
vett scan . --provider openrouter
vett scan . --provider openai --model gpt-4o-mini
vett version
vett version --short

📊 What Vett Checks

Check Description
🔐 Security Hardcoded secrets, unsafe eval/exec, SQL injection patterns
📏 Complexity Functions longer than 50 lines
📦 Large files Files over 300 lines
📝 TODOs Unresolved TODO/FIXME/HACK comments
🤖 AI Analysis Project summary, grade, strengths, suggestions

📁 Output

  • Colorful terminal report
  • vett_report.md saved in your target folder

🛠️ Troubleshooting

  • vett: command not found -> reinstall with pip install -U vett and restart terminal
  • UnicodeEncodeError on Windows -> set PYTHONUTF8=1 before running
  • No source files found -> verify the target has code files (.py, .js, .ts, ...)

🤝 Open Source

  • License: MIT (LICENSE)
  • Contributing guide: CONTRIBUTING.md
  • Security policy: SECURITY.md
  • Changelog: CHANGELOG.md

🧪 For Contributors

pip install -e .
vett scan . --no-ai

📤 Release Process (PyPI)

  1. Update vett/__init__.py version.
  2. Update CHANGELOG.md.
  3. Push to main.
  4. Create a GitHub release or version tag.
  5. Workflow .github/workflows/publish-pypi.yml publishes to PyPI.

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

vett-0.1.6.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vett-0.1.6-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file vett-0.1.6.tar.gz.

File metadata

  • Download URL: vett-0.1.6.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vett-0.1.6.tar.gz
Algorithm Hash digest
SHA256 8ddb60fc4367cebc3489ed4338d9dffea759e2e586eac99e449c541a5037f3a1
MD5 4da1c625e28bdaac7e4d140c77714d30
BLAKE2b-256 14fe3be23acb25bbbbbd56946a1b3e5fc60a0d70e14ffa835e3ee6d829f1068e

See more details on using hashes here.

Provenance

The following attestation bundles were made for vett-0.1.6.tar.gz:

Publisher: publish-pypi.yml on madhavbuilds/Vett

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vett-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: vett-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vett-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 faf053ac3c90abf9737383b56bffe44cf35710d32432d98f3f7f566fd22ccd6f
MD5 22e7b870effa0bfb8f129da6781bf738
BLAKE2b-256 c3a5e7d11dd5c42481a19f5387e93513f271262278142f1e260c64f5a74498a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for vett-0.1.6-py3-none-any.whl:

Publisher: publish-pypi.yml on madhavbuilds/Vett

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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