A powerful tool for analyzing dependency updates and their changelogs. Automatically fetches and displays changelog information for updated packages, helping you understand what changed in your dependencies.
Want to see more of my work? Check out the Bitcart project - a comprehensive cryptocurrency payment processor:
- 🔍 Automatic Changelog Detection: Finds changelogs from GitHub releases, repository files, and PyPI
- 📊 Rich Output: Beautiful, formatted output with syntax highlighting
- 🔧 Multiple Package Managers: Currently supports
uvwith more coming soon - 🚀 Fast & Reliable: Efficient parsing and caching for quick results
- 🔐 GitHub Integration: Optional GitHub token support for higher API rate limits
- 📝 Multiple Formats: Supports various changelog formats (Markdown, RST, Sphinx)
pip install changelog-checkerThe most common usage is to pipe package manager output directly to changelog-checker:
# Update dependencies and check changelogs
uv sync -U 2>&1 | changelog-checker
# Or save output to file first
uv sync -U &> updates.txt
changelog-checker -i updates.txt
# or get html report
changelog-checker -i updates.txt -f html -o report.html
# or use with (uv) pip to check changelogs of pinned dependencies
uv pip list --outdated | changelog-checker -p pip# Pipe uv output directly
uv sync -U 2>&1 | changelog-checker
# Read from file
changelog-checker --input-file updates.txt
# Enable verbose output
changelog-checker -v --input-file updates.txt
# Use GitHub token for higher rate limits
export GITHUB_TOKEN=your_token_here
uv sync -U 2>&1 | changelog-checkerOptions:
-i, --input-file FILENAME Read input from file instead of stdin
-p, --parser [uv|pip] Parser type to use (default: uv)
--log-level [DEBUG|INFO|WARNING|ERROR]
Logging level (default: INFO)
-v, --verbose Enable verbose output (equivalent to --log-
level DEBUG)
-t, --github-token TEXT GitHub API token for authentication (can
also use GITHUB_TOKEN env var)
-f, --output-format [terminal|html]
Output format: terminal (rich console) or
html (HTML file) (default: terminal)
-o, --output-file TEXT Output file path for HTML format (default:
changelog_report.html)
-h, --help Show this message and exit.GITHUB_TOKEN: GitHub API token for authentication (optional but recommended)
When you run changelog-checker, you'll see a beautifully formatted report like this:
╭─────────────────────────────╮
│ 📦 Dependency Update Report │
╰─────────────────────────────╯
╭──────────────────────────────────────────────────────────────────────────────────────────── Summary ────────────────────────────────────────────────────────────────────────────────────────────╮
│ │
│ 📈 Updated 74 │
│ ➕ Added 1 │
│ ➖ Removed 1 │
│ 📝 Missing Changelogs 4 │
│ │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─────────────────────╮
│ 📈 Updated Packages │
╰─────────────────────╯
╭───────────────────────────────────────────────────────────────────── aiohappyeyeballs: 2.4.4 → 2.6.1 (GitHub | Changelog) ──────────────────────────────────────────────────────────────────────╮
│ Changelog: │
│ │
│ Version 2.6.1: │
│ v2.6.1 (2025-03-12) │
│ │
│ Bug Fixes │
│ │
│ • Resolve TypeError on import for Python < 3.9.2 (#151, │
│ 2042c82) │
│ │
│ ──────────────────────────────────────────────────────────────────────────────── │
│ Detailed Changes: v2.6.0...v2.6.1 │
│ │
│ Version 2.6.0: │
│ v2.6.0 (2025-03-11) │
│ │
│ Features │
│ │
│ • docs: Publish documentation (#149, │
│ 4235273) │
│ │
│ Creates an api_reference.rst file to expose the existing documentation for the │
│ few functions that have docstrings, as well as add documentation for │
│ AddrInfoType and SocketFactoryType. Now, these can be properly pointed to by │
│ other projects' documentation. │
│ │
│ ──────────────────────────────────────────────────────────────────────────────── │
│ Detailed Changes: v2.5.0...v2.6.0 │
│ │
│ Version 2.5.0: │
│ v2.5.0 (2025-03-06) │
│ │
│ Features │
│ │
│ • Add callback for users to customize socket creation (#147, │
│ 8e1bc6a)You can also generate HTML reports for later viewing:
changelog-checker -i updates.txt -f html -o report.html
Currently supported:
- uv: Python package manager
- pip: Pip (only "list --outdated")
- Parse Input: Analyzes package manager output to identify updated packages
- Find Packages: Searches for package information on PyPI and GitHub
- Fetch Changelogs: Retrieves changelog information from multiple sources:
- GitHub releases API
- Repository changelog files (CHANGELOG.md, HISTORY.md, etc.)
- PyPI project descriptions
- Parse & Format: Processes changelog content and presents it in a readable format
For better rate limits and access to private repositories, set up a GitHub token:
-
Go to GitHub Settings → Developer settings → Personal access tokens
-
Generate a new token with
public_reposcope -
Set the environment variable:
export GITHUB_TOKEN=your_token_here
git clone https://github.com/MrNaif2018/changelog-checker.git
cd changelog-checker
uv syncuv run task test# Run linting
uv run task lint
# Type checking
uv run task lint_types
# Run all checks
uv run task ciContributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Copyright (C) 2025 MrNaif2018
Licensed under the MIT license
- github-reserved-names for a list of names to avoid treating as a github user during parsing