Skip to main content

Software Composition Risk Intelligence — score the real cost of updating a dependency

Project description

scori

Software Composition Risk IntelligenceKnow the cost before you update.

PyPI Python License CI

Free tools like pip-audit, OSV-Scanner, and Dependabot detect vulnerabilities and open update PRs — but none of them answer the question that matters: is it worth updating this lib right now, or does the migration cost outweigh the risk of not doing it? scori quantifies that friction as a single 0–100 score per dependency, using public data from PyPI, GitHub, and the OSV vulnerability database.

Install

pip install scori
# or
uv add scori

Usage

# Show friction scores for every dependency
scori friction --path .
scori friction --path . --format json > report.json
scori friction --path . --format html        # writes scori-report.html
scori friction --path . --format markdown    # markdown table (GitHub / PR comments)
scori friction --path . --ci                 # exit 1 if any score > 75
scori friction --path . --ci --threshold 50  # stricter gate

# Show only dependencies with updates available, sorted by friction
scori monitor --path .
scori monitor --path . --watch               # re-check every 5 minutes
scori monitor --path . --watch --interval 60 # re-check every 60 s

# Preview and apply dependency version updates
scori update --path . --dry-run              # show what would change
scori update --path . --apply                # write changes + create backup
scori update --path . --apply --max-friction medium  # only Low/Medium deps
scori update --path . --rollback             # restore from last backup

# Generate a standalone report
scori report --path .                        # writes scori-report.html
scori report --path . --format json          # prints JSON to stdout
scori report --path . --output out.html      # custom output path
scori report --path . --ci --threshold 60    # exit 1 if any score > 60

# List all detected dependencies
scori scan --path .

Example output (scori friction --format table, with color indicators):

                          scori — friction scores
┌───────────┬─────────┬─────────┬───────┬───────┬──────────┬─────────┐
│ Package   │ Current │ Latest  │ Jump  │ Score │ Label    │  CVEs   │
├───────────┼─────────┼─────────┼───────┼───────┼──────────┼─────────┤
│ django    │ 3.2.0   │ 5.1.0   │ major │  78   │ Critical │ 3 → 0 ✓ │
│ nltk      │ 3.8.1   │ 3.9.4   │ minor │  35   │ Medium   │ 9 → 0 ✓ │
│ requests  │ 2.31.0  │ 2.32.3  │ patch │   8   │ Low      │    —    │
└───────────┴─────────┴─────────┴───────┴───────┴──────────┴─────────┘

The CVEs column shows known vulnerabilities in your current version and whether they are fixed in the latest release:

  • 9 → 0 ✓ — 9 CVEs in current, all fixed in latest (prioritize this update)
  • 3 — 3 CVEs, still present in latest (update won't help with security)
  • — no known vulnerabilities in either version

scori monitor shows only the packages that have a newer release available, sorted by friction score (highest first), and marks with ★ any package where updating also fixes known CVEs.

When a package has CVEs that are not fixed in the latest version, scori searches PyPI online for alternatives with 0 known vulnerabilities and suggests them below the table:

⚠ Unresolved CVEs — consider these alternatives:
  python-jose (3 CVEs, not fixed in latest) → joserfc, authlib
  requests    (1 CVE,  not fixed in latest) → httpx

Alternatives are discovered dynamically: scori extracts keywords from the vulnerable package's PyPI metadata, searches for similar packages, and verifies each candidate against the OSV database before suggesting it. No hardcoded list — any package on PyPI is a potential alternative.

How it works

The friction score is a weighted sum of six components (max 100):

Component Max weight Logic
Semantic version jump 50 patch=5, minor=25, major=50
Breaking signals in changelog 20 +4 per keyword found in release notes or CHANGELOG
Affected transitive dependencies 15 +3 per reverse dep (from uv.lock/poetry.lock)
CVEs fixed by updating 15 +3 per fixed CVE (CRITICAL CVEs count double)
Months without updating in project 10 +1 per month (max 10)
Current version yanked 5 +5 if yanked: true in PyPI API

Labels:

  • 0–25 → LowSafe to update
  • 26–50 → MediumUpdate with tests
  • 51–75 → HighUpdate in isolated branch
  • 76–100 → CriticalManual migration required

CVE data is fetched from the OSV database (free, no auth required). CVEs that are fixed by updating contribute up to +15 points to the friction score. CRITICAL-severity CVEs (CVSS ≥ 9.0, as reported by the GitHub Advisory Database) count double, so the most dangerous vulnerabilities push the package higher in your update queue. CVEs that remain in the latest version do not affect the score (updating won't help with those).

Transitive dependency counts are read directly from uv.lock or poetry.lock when present — no more always-zero placeholder.

Data sources

Source Data
https://pypi.org/pypi/{pkg}/json Latest version, release dates, yanked status
https://api.github.com/repos/{owner}/{repo}/releases Release notes for breaking signal detection
https://raw.githubusercontent.com/…/CHANGELOG.md CHANGELOG for additional breaking signal scanning
https://api.osv.dev/v1/query Known CVEs per version with severity

Set GITHUB_TOKEN in your environment to raise the GitHub API rate limit from 60/h to 5000/h. PyPI and GitHub release data is cached in ~/.cache/scori/ for 1 hour. OSV results are cached in memory for the duration of a single run.

Version resolution

For pinned dependencies (fastapi==0.115.8), the pinned version is used directly. For unpinned dependencies (uvicorn with no version), scori looks up the installed version in the project's local venv (.venv/, venv/, or env/) before falling back to 0.0.0.

GitHub Actions

Add scori to any workflow in one step:

- uses: pauloestevao795/scori@v0.4.0
  with:
    threshold: '75'       # fail if any dep score exceeds this (default: 75)
    comment-pr: 'true'    # post friction table as a PR comment
    github-token: ${{ secrets.GITHUB_TOKEN }}

Full example — gate PRs that touch dependency files:

name: scori friction check
on:
  pull_request:
    paths:
      - 'requirements*.txt'
      - 'pyproject.toml'
      - 'setup.cfg'

jobs:
  friction:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
    steps:
      - uses: actions/checkout@v4
      - uses: pauloestevao795/scori@v0.4.0
        with:
          threshold: '75'
          comment-pr: 'true'
          github-token: ${{ secrets.GITHUB_TOKEN }}

Pre-commit hook

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/pauloestevao795/scori
    rev: v0.4.0
    hooks:
      - id: scori-friction
        args: [--threshold, '75']  # optional: override default threshold

The hook runs scori friction --ci and blocks the commit if any dependency exceeds the threshold. It only fires when requirements*.txt, pyproject.toml, or setup.cfg are staged.

Roadmap

  • v0.5 — score history, .scori.toml risk profiles, LLM changelog summaries

Contributing

PRs and issues are welcome. Local setup:

git clone https://github.com/pauloestevao795/scori
cd scori
uv sync --group dev
uv run pre-commit install
uv run pytest

License

MIT

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

scori-0.4.0.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

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

scori-0.4.0-py3-none-any.whl (20.6 kB view details)

Uploaded Python 3

File details

Details for the file scori-0.4.0.tar.gz.

File metadata

  • Download URL: scori-0.4.0.tar.gz
  • Upload date:
  • Size: 27.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for scori-0.4.0.tar.gz
Algorithm Hash digest
SHA256 fd2478f2e76f09773be0e0e5d071b25806c8fe5cf2e2537560e675776c2d60e4
MD5 93a409c1c3a5d9271c1aaa56ab2a5bea
BLAKE2b-256 3c9447241d8b666f9fe03aec7088fdb9af4cfcda8b65a33f534e15c36b8d7c87

See more details on using hashes here.

File details

Details for the file scori-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: scori-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 20.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for scori-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 de17f14d3199e91b3aff6d9c8a67b41f229d1b4c108c502ebfcc84f5301c4318
MD5 9f66fa1823c421c455170085718d171c
BLAKE2b-256 9c3174e8ae232dd984e3b1481d973f717588b094f0b73b2c86503522f736e62c

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