Skip to content

Zaojun Documentation

Welcome to the Zaojun documentation! Zaojun is a command-line tool that checks your Python project dependencies against the latest versions available on PyPI.

What is Zaojun?

Zaojun (named after the Chinese Kitchen God, a household guardian) helps keep your project dependencies in harmony by:

  • ✅ Checking dependencies in your pyproject.toml file
  • 🔍 Comparing versions against PyPI
  • 📊 Showing update status with clear visual indicators
  • 🔧 Supporting dependency groups and optional dependencies
  • ⚡ Providing fast, focused output options

Key Features

Simple Dependency Checking

zaojun
Check all dependencies in your pyproject.toml file.

Dependency Group Support

zaojun --groups
Check dependencies in all groups (development, testing, etc.).

Minimal Output

zaojun --short
Show only essential information about updates needed.

Compatible Updates

zaojun --compat-ok
Treat compatible version updates as acceptable (won't cause exit code 1).

Visual Indicators

Zaojun uses clear symbols to show dependency status:

  • ✅ Green checkmark: Dependency is up to date
  • ⚠️ Yellow warning: Newer compatible version available
  • ❌ Red cross: Newer incompatible version available

Example Output

Checking dependencies in /path/to/pyproject.toml
✅️ httpx~=0.28.1 is up to date
⚠️ packaging: ~=23.0 → Latest: 24.0
❌ typer: ~=0.9.0 → Latest: 1.0.0

Checking dependency group [dev]
✅️ ruff~=0.15.1 is up to date
✅️ pytest~=9.0.2 is up to date

Why Use Zaojun?

  • Focused: Does one thing well - check dependency versions
  • Fast: Minimal overhead, quick execution
  • Clear: Easy-to-understand output with visual indicators
  • Flexible: Works with dependency groups and various version specifiers
  • Integratable: Can be used in CI/CD pipelines and pre-commit hooks

Getting Help

License

Zaojun is licensed under the AGPL-3.0-or-later license.