wtpython 0.1.0
A TUI that interactively helps you solve errors that might arise in your code.
License: MIT
Requires Python: >=3.7,<4.0

![PyPI - License](https://img.shields.io/pypi/l/wtpython)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/wtpython)
![PyPI - Status](https://img.shields.io/pypi/status/wtpython)
![PyPI](https://img.shields.io/pypi/v/wtpython)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/wtpython)
![PyPI - Downloads](https://img.shields.io/pypi/dm/wtpython)
[![Discord](https://img.shields.io/discord/862056949066891284.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/DqdKBeUTmw)

![Logo](https://avatars.githubusercontent.com/u/87154160?s=200&v=4)

# What the Python?!

Find solutions to your Python errors without leaving your IDE or terminal!

Ever have Python throw an error traceback longer than a CVS receipt 🧾? Is it dizzying to read through a bunch of cryptic lines trying to figure out exactly what caused the error? Do you look at the traceback and go, "WHAT THE ....."?😕

What the Python (`wtpython`) is a simple terminal user interface that allows you to explore relevant answers on StackOverflow without leaving your terminal or IDE. When you get an error, all you have to do is swap `python` for `wtpython`. When your code hits an error, you'll see a textual interface for exploring relevant answers allowing you to stay focused and ship faster! 🚀

`wtpython` is styled using [Rich](https://rich.readthedocs.io/en/stable/) and the interface is developed using [Textual](https://github.com/willmcgugan/textual).

Like what you see? Feel free to share `#wtpython` on social media!

## Installation

This project is hosted on [PyPI](https://pypi.org/project/wtpython/), allowing you to install it with pip.

```
pip install wtpython
```

## Usage

When you're coding and running your script or application, then all of a sudden, you see an error and think to yourself "what the...?"

```
$ python example/division_by_zero_error.py
Traceback (most recent call last):
  File "/home/cohan/github/what-the-python/wtpython/example/division_by_zero_error.py", line 1, in <module>
    1 / 0
ZeroDivisionError: division by zero
```

All you have to do is jump to the beginning of the line and change `python` to `wtpython` and the magic will happen.

```
$ wtpython example/division_by_zero_error.py
# Magic! 🎩
```

![usage](https://raw.githubusercontent.com/what-the-python/wtpython/main/docs/_images/Usage.gif)

If you want results but don't want to go into the interface, just pass the `-n` flag to see the Rich formatted traceback and links to the most relevant  questions on StackOverflow.

![no-display-usage](https://raw.githubusercontent.com/what-the-python/wtpython/main/docs/_images/No%20Display%20Usage.gif)

If you want, you can always run `wtpython` in place of `python`. `wtpython` is designed to allow your code to function normally and only acts when your code hits an error. **`wtpython` will even allow you to pass arguments to your own script!** If our code hits an error, please [let us know](https://github.com/what-the-python/wtpython/issues).

### Command Line Options

All command line options should be passed before your script and arguments passed to your script.

Flag | Action
---|---
`-n` or `--no-display` | Do not enter the interactive session, just print the error and give me the links!
`-c` or `--copy-error` | Add the error message to your clipboard so you can look for answers yourself (it's okay, we understand).
`--clear-cache` | `wtpython` will cache results of each error message for up to a day. This helps prevent you from getting throttled by the StackOverflow API.

### Interface Hotkeys

Key | Action
---|---
<kbd>s</kbd>| Toggle the sidebar (questions list)
<kbd>t</kbd>| View the traceback
<kbd>←</kbd>, <kbd>k</kbd>| View previous question
<kbd>→</kbd>, <kbd>j</kbd>| View next question
<kbd>d</kbd>| Open question in your browser
<kbd>f</kbd>| Search for answers on Google
<kbd>q</kbd>, <kbd>ctrl</kbd>+<kbd>c</kbd> | Quit the interface.
<kbd>i</kbd> | Report an issue with `wtpython`

## Roadmap

This project is still in the early phases, but we have big plans going forward. We hope to tackle:

- Windows support (without WSL)
- Jupyter integration
- More interactive interface
- User configuration settings
- Much much more!

## Feedback / Support

If you have any feedback, please [create an issue](https://github.com/what-the-python/wtpython/issues) or [start a discussion](https://github.com/what-the-python/wtpython/discussions). There is also a Discord server which you can join with this [invite](https://discord.gg/DqdKBeUTmw).

## Contributing

See [CONTRIBUTING.md](https://github.com/what-the-python/wtpython/blob/main/CONTRIBUTING.md)