pyupcheck

Check if upgrading a Python dependency will break your code.

$ pyupcheck check requests 3.0.0

pyupcheck 2.31.0 -> 3.0.0

Found 14 usages across 5 files.
Found 3 potentially breaking/deprecated changes.

BREAKING (1):

  x src/api.py:23  resp = requests.get(url, verify=False)
    Removed: `verify` parameter no longer accepted

DEPRECATED (1):

  ! src/utils.py:8  from requests.packages import urllib3
    Deprecated: use `urllib3` directly instead

12 other usages are safe.

╭─ pyupcheck report ──────────────────────────────────╮
│ Upgrade risky. 1 breaking change(s) affect your    │
│ code.                                              │
╰────────────────────────────────────────────────────╯

Install

pip install pyupcheck

Usage

Check an upgrade

# check against a specific version
pyupcheck check flask 3.0.0

# check against the latest version
pyupcheck check flask

# scan a specific directory
pyupcheck check requests 3.0.0 --dir ./src

# json output for CI
pyupcheck check requests 3.0.0 --json-output

Exit code is 1 if breaking changes are found, 0 otherwise. Use this in CI to gate upgrades.

Scan your code

# just see what APIs you use from a package
pyupcheck scan requests

List versions

pyupcheck versions flask

How it works

1. Scans your .py files with AST parsing to find every import and usage of the target package
2. Fetches the changelog from GitHub releases and PyPI metadata
3. Parses the changelog for breaking changes, deprecations, and renames
4. Cross-references your usage against the changes
5. Reports which of your usages are at risk

Limitations

• Changelog parsing relies on maintainers writing structured changelogs. If a project has unstructured notes, pyupcheck may miss changes.
• Dynamic attribute access (getattr(requests, method_name)) is not detected.
• Only scans .py files (not Jupyter notebooks, config files, etc.)

Options

License

MIT