Skip to main content

Comprehensive health assessments for Python project dependencies

Project description

Dependency Health Monitor (DHM)

Comprehensive health assessments for Python project dependencies.

PyPI version Python 3.10+ License: MIT

Features

  • Health Scoring: Weighted composite scores based on security, maintenance, community, and popularity
  • Vulnerability Detection: Real-time scanning via OSV database with open vs fixed classification
  • Maintenance Analysis: Identifies abandoned, deprecated, or archived packages
  • License Evaluation: Categorizes licenses (permissive, copyleft, weak copyleft)
  • Caching: SQLite-based caching reduces API calls and improves performance
  • CI/CD Ready: Exit codes for pipeline integration

Installation

pip install dependency-health-monitor

Or install from source:

git clone https://github.com/dhm/dependency-health-monitor
cd dependency-health-monitor
pip install -e ".[dev]"

Quick Start

Command Line

# Scan current project
dhm scan

# Check a single package
dhm check requests

# Find alternatives for a problematic package
dhm alternatives urllib3

# Output as JSON for CI/CD
dhm scan -f json -o report.json

# Fail CI if high+ severity issues found
dhm scan --fail-on high

Python Library

import asyncio
from dhm import check, scan

async def main():
    # Check a single package
    report = await check("requests")
    print(f"{report.package.name}: Grade {report.health.grade}")
    print(f"  Security: {report.health.security_score:.0f}")
    print(f"  Open vulnerabilities: {len(report.health.open_vulnerabilities)}")

    # Scan a project directory
    reports = await scan(".")
    for r in reports:
        if r.health.has_open_vulnerabilities:
            print(f"⚠️  {r.package.name} has {len(r.health.open_vulnerabilities)} open vulns")

asyncio.run(main())

Synchronous API (for non-async contexts):

from dhm import check_sync, scan_sync

report = check_sync("flask")
print(f"Flask health: {report.health.grade} ({report.health.overall:.0f}/100)")

reports = scan_sync("/path/to/project")
unhealthy = [r for r in reports if r.health.is_concerning]

Health Score Algorithm

DHM calculates a composite health score using weighted components:

Component Weight Data Sources
Security 35% OSV vulnerability database
Maintenance 30% PyPI release dates, GitHub activity
Community 20% Contributors, stars, PR merge rates
Popularity 15% pypistats.org download counts

Grade Thresholds:

Grade Score Meaning
A ≥ 85 Excellent - Well maintained, secure, popular
B ≥ 75 Good - Minor concerns, generally safe
C ≥ 65 Acceptable - Some issues, monitor closely
D ≥ 55 Concerning - Significant issues, consider alternatives
F < 55 Critical - Major problems, action required

Vulnerability Classification

DHM distinguishes between open and fixed vulnerabilities:

  • Open: Affects your installed version - action required
  • Fixed: Was present in older versions but patched in yours - historical only
report = await check("aiohttp", version="3.13.3")

# Only shows vulnerabilities affecting version 3.13.3
for vuln in report.health.open_vulnerabilities:
    print(f"🔴 {vuln.id}: {vuln.title}")
    if vuln.fixed_version:
        print(f"   Fix: Upgrade to {vuln.fixed_version}")

Caching

DHM caches API responses to improve performance and reduce rate limiting:

Data Type TTL Rationale
GitHub repo data 24 hours Metrics change slowly
PyPI metadata 1 hour Releases are occasional
Download stats 6 hours Updated daily
Vulnerabilities 6 hours Security-critical, stay current
# View cache statistics
dhm cache --stats

# Clear all cached data
dhm cache --clear

# Remove only expired entries
dhm cache --cleanup

# Invalidate specific data
dhm cache --invalidate 'github:%'

Configuration

Add to your pyproject.toml:

[tool.dhm]
include_transitive = true
cache_ttl = 3600

[tool.dhm.thresholds]
min_grade = "C"
max_vulnerabilities = 0
max_abandoned = 0

CI/CD Integration

# GitHub Actions example
- name: Check dependency health
  run: |
    pip install dependency-health-monitor
    dhm scan --fail-on high -f json -o dhm-report.json

- name: Upload report
  uses: actions/upload-artifact@v3
  with:
    name: dependency-health-report
    path: dhm-report.json

Environment Variables

Variable Description
GITHUB_TOKEN GitHub API token for higher rate limits (5000/hr vs 60/hr)

License

MIT - See LICENSE for details.

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

dependency_health_monitor-0.1.0.tar.gz (80.1 kB view details)

Uploaded Source

Built Distribution

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

dependency_health_monitor-0.1.0-py3-none-any.whl (55.7 kB view details)

Uploaded Python 3

File details

Details for the file dependency_health_monitor-0.1.0.tar.gz.

File metadata

File hashes

Hashes for dependency_health_monitor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9cfa2d5f5c686bc95aedb3f7e301f0e33fef5e51fb6612928956644faa004a36
MD5 dd276647dc35618eb1d4eb5d8da54bcc
BLAKE2b-256 dcc69aafa231b457acd544ae48a1cf1139656a6ee89bf785c29e6e92a7bdaccb

See more details on using hashes here.

File details

Details for the file dependency_health_monitor-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dependency_health_monitor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8531e0a38ca5013f2fb0ca3a43aeb2207196cb59bfe7e8fe03473bec962a5d1d
MD5 aa7fe6342283a95a6abbb8a81da2e200
BLAKE2b-256 a28b55858227614fa044f55b1addca4b06efd46712b774e8663e3807c011f65f

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