Skip to main content

Track technical debt before it blows up in production

Project description

DebtPilot

Track technical debt before it blows up in production.

Every IDE catches syntax errors. DebtPilot does something no IDE can — it knows that payments/stripe.js has been edited 30 times by 4 different developers, has a TODO from 8 months ago, and a complexity score of 24. That combination is your next production incident.


Install

pip install debtpilot

Full install (file watcher + live notifications):

pip install "debtpilot[full]"


Quickstart — 4 commands, done

  1. Scan your project debtpilot scan .

  2. See the report debtpilot report

  3. Block bad commits automatically debtpilot hook --install

  4. Start live background watching debtpilot start --dir .


What it does

Command What happens
debtpilot scan . Scores every file 0-100 for technical debt
debtpilot report Shows top debt files in a ranked table
debtpilot file <path> Deep breakdown of one file
debtpilot ai <path> AI explains exactly what to fix (needs Gemini key)
debtpilot predict Predicts which file will cause your next bug
debtpilot dashboard Generates an HTML dashboard — open in browser
debtpilot report-pdf Generates a print-ready PDF report
debtpilot alerts Shows active danger alerts
debtpilot todos Lists stale TODOs by age
debtpilot hook --install Blocks commits above the debt threshold
debtpilot start Starts live file watcher + WebSocket server
debtpilot status Full health check of your DebtPilot setup
debtpilot digest --send Sends weekly email summary to your team

Debt Score (0-100)

Grade Score Meaning
A 0-25 Healthy
B 26-45 Watch
C 46-65 Concerning
D 66-80 Dangerous
F 81-100 Critical — fix before next deploy

Score = weighted combination of: git churn (30%) + complexity (25%) + lint issues (20%) + stale TODOs (15%) + staleness (10%).


AI Fix Suggestions (optional)

Get a free Gemini API key at aistudio.google.com then:

debtpilot config --gemini-key YOUR_KEY debtpilot ai src/payments.py

DebtPilot sends the file context to Gemini and gets back exact fix suggestions with code examples and effort estimates.


Weekly Email Digest

debtpilot config --gmail you@gmail.com --gmail-password YOUR_APP_PASS --recipients team@company.com debtpilot digest --send

Use a Gmail App Password from: myaccount.google.com/apppasswords


Auto-start on Windows login

debtpilot autostart --install --dir .

DebtPilot will start silently in the background every time Windows starts. No manual debtpilot start needed.


Requirements

  • Python 3.10 or higher
  • git in PATH
  • pylint / mypy / eslint — optional, for richer lint scores

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

debtpilot-0.1.0.tar.gz (37.4 kB view details)

Uploaded Source

Built Distribution

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

debtpilot-0.1.0-py3-none-any.whl (44.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: debtpilot-0.1.0.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for debtpilot-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6593748ca0a626a7c70d4a0ddda2c1960b64143d9e24eec53a26e85ec029979c
MD5 54357f180704a9ad5ee4da05c23bf7f8
BLAKE2b-256 6eaf58e8325c896bb2a3fe79722df6ad189508176fd46f8b80d6f70562250a35

See more details on using hashes here.

File details

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

File metadata

  • Download URL: debtpilot-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 44.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for debtpilot-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ccad1f06f54e52e8861fa4000f4e6cb411ba61e64882bf5fd4f95b861c3d1b9
MD5 2f8ac877b9dd961f54ed10060ec4e61a
BLAKE2b-256 c6cbfa2dcbad07191364bb164bfd020b2a19dba1e8e9099cb96a2f951f440368

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