Metadata-Version: 2.5
Name: errinshort
Version: 0.1.0
Summary: Long Python error? Get it in short: what broke, and how to fix it.
Author: Aditi Dubey
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.9
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Description-Content-Type: text/markdown

# errinshort

**Error too long? Here's the short version.**

Your code crashes. Python gives you 50 lines. Your ADHD mind open Instagram.

`errinshort` adds a tiny card at the end: what broke, why, and how to fix it. Read it in 5 seconds.

## Install

```bash
pip install errinshort
```

## Use

Add one line at the top of your script:

```python
import errinshort
```

That's it.

## What you get

```
KeyError: 'missing'

╭─ KeyError ─────────────────────────────────────
│
│   o━━┳┳   x   { ... }
│
│   That key? Never heard of her.
│
│   The dictionary doesn't have this key.
│   → Use my_dict.get("key") to get None instead
│     of a crash.
╰────────────────────────────────────────────────
```

- 🎨 a tiny drawing
- 😂 a funny line
- 🧠 what it means, in one line
- 🔧 how to fix it

The full error is still there above the card, in case you need it.

## Try the cards

```bash
errinshort              # list all 66 errors
errinshort KeyError     # see one card
errinshort all          # see every card
```

## Good to know

- Works for all 66 built-in Python errors.
- Errors from other libraries get the card of the closest built-in error.
- Soft colors. Turn them off with `NO_COLOR=1`.
- No extra packages needed.

## License

MIT
