🩺 project-doctor

project-doctor is a CLI tool that diagnoses the health of any Python project. Run it inside your project folder and get an instant, colorful report of what's missing, what's misconfigured, and what needs attention.

🚀 Installation

pip install project-doctor

📋 Usage

# Diagnose the current directory
project-doctor

# Diagnose a specific path
project-doctor --path /path/to/my_project

# Strict mode: exit with code 1 if any errors found
project-doctor --strict

📊 Sample Output

╔══════════════════════════════════════════════════════╗
║          🩺 Project Doctor — Health Report           ║
╚══════════════════════════════════════════════════════╝

  Scanning: /home/user/my_project

  ┌─────────────────────────────────────────────────────┐
  │ Check               │ Status │ Message               │
  ├─────────────────────────────────────────────────────┤
  │ README              │  ✅    │ Found README.md        │
  │ LICENSE             │  ✅    │ Found LICENSE          │
  │ .gitignore          │  ✅    │ Found .gitignore       │
  │ Git repository      │  ✅    │ .git directory found   │
  │ tests/              │  ⚠️    │ No tests/ folder found │
  │ pyproject.toml      │  ✅    │ Valid config found     │
  │ name field          │  ✅    │ "my_project"           │
  │ version field       │  ✅    │ "1.0.0"                │
  │ description         │  ⚠️    │ Description is empty   │
  │ requires-python     │  ✅    │ ">=3.9"                │
  │ dependencies        │  ✅    │ 3 dependencies listed  │
  │ __init__.py docstr  │  ❌    │ Missing module docstr  │
  └─────────────────────────────────────────────────────┘

  Score: 9/12 checks passed

  🟡 Your project needs some attention. Fix warnings above.

✅ Checks Performed

🛠 Development

git clone https://github.com/paola/project-doctor
cd project-doctor
pip install -e ".[dev]"
pytest tests/ -v

📄 License

MIT © Paola