Metadata-Version: 2.4
Name: codemri
Version: 0.1.1
Summary: Instant code quality reports for your Python projects — style, complexity, and an overall health score in one command
Author-email: Suzzane Koranteng <korantengsuzzane@gmail.com>
License-Expression: MIT
Keywords: code quality,linting,complexity,cli,developer tools,static analysis
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: typer>=0.9.0
Requires-Dist: rich>=13.0.0
Requires-Dist: ruff>=0.4.0
Requires-Dist: radon>=6.0.0

# CodeMRI

**Instant code quality reports for your Python projects.**

CodeMRI scans your codebase and gives you a single, easy-to-read health score — combining style violations and code complexity into one number, so you know exactly how healthy your code is and where to focus first.

## Why CodeMRI?

Most linters dump a wall of warnings and leave you to figure out what matters. CodeMRI instead gives you:

- **One overall health score (0–100)** with a letter grade — like an MRI scan for your code
- **A "Worst Offenders" leaderboard** — the exact functions and files causing the most pain, ranked by severity
- **A clean, shareable HTML report** — perfect for pasting into a PR or sharing with your team
- **Score history tracking** — see whether your codebase is improving or rotting over time, right from the CLI

## Installation

```bash
pip install codemri
```

## Usage

Scan the current directory:

```bash
codemri scan .
```

Scan a specific file or folder:

```bash
codemri scan path/to/project
```

Generate a shareable HTML report:

```bash
codemri scan . --html
```

View your score history over time:

```bash
codemri history .
```

Check the installed version:

```bash
codemri --version
```

## Example output

────────────────── Overall Code Health ──────────────────╮
│ 69/100   Grade: C                                        │
╰────────────────────────────────────────────────────────╯
Style score: 39/100  (9 issues across 59 lines)
Complexity score: 98/100  (1 files analyzed)

## How scoring works

- **Style score** — based on the density of style/lint issues (via [ruff](https://github.com/astral-sh/ruff)) relative to lines of code
- **Complexity score** — based on cyclomatic complexity rankings (via [radon](https://github.com/rubik/radon)) across all functions
- **Overall score** — a 50/50 weighted average of the two, mapped to a letter grade (A–F)

## License

MIT
