A professional Python error explainer CLI that converts tracebacks into human-friendly explanations.
Project description
Vox
Vox — A professional Python error explainer CLI
Turn confusing Python tracebacks into clear, beginner-friendly explanations.
🚀 What is Vox?
Vox is a command-line tool that transforms Python errors into easy-to-understand explanations.
It helps beginners and professionals debug faster by explaining:
- What went wrong
- Where it happened
- How to fix it
- Full traceback (optional)
✨ Features
| Mode | Output Type | Use Case |
|---|---|---|
| ✅ Standard | Friendly explanation | Default |
| 🔍 Verbose | Full traceback + explanation | Debug deep issues |
| ⚡ Minimal | One-line error only | Quick look |
| 🚫 Off | Standard Python traceback | Turn off Vox |
| 📄 Log | Save output to a file | Share with others |
💻 Installation
pip install vox
🎯 Usage
✅ Standard Mode (Default)
Bash
python -m vox test.py
🔍 Verbose Mode
Bash
python -m vox --verbose test.py
⚡ Minimal Mode
Bash
python -m vox --minimal test.py
🚫 Off Mode (Standard Python output)
Bash
python -m vox --off test.py
📄 Save Output to Log File
Bash
python -m vox --log mylog.txt test.py
🧩 Example Output
🧠 Standard
❌ vox says something went wrong. > What happened: You used a name that Python does not recognize.
Where it happened: File: test.py, Line: 1, Code: print(y)
🔍 Verbose
🧠 Full traceback: > NameError: name 'y' is not defined
🧠 How Vox Works
Vox intercepts Python exceptions and converts them into:
Friendly explanation
Error location
Possible fix
This makes debugging faster and easier — especially for beginners.
🛠️ Contributing
Contributions are welcome! If you want to add new error explainers, follow these steps:
Fork the repo
Create a new branch
Add a new explainer file
Submit a PR
📄 License
This project is licensed under the MIT License. See the LICENSE file for details.
⭐ Show your support
If Vox helped you, ⭐ star the repo and share it with your friends!
<div align="center"> <strong>Made with ❤️ by <a href="https://github.com/krishh2530">krishh2530</a></strong> </div>
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file voxie-0.1.0.tar.gz.
File metadata
- Download URL: voxie-0.1.0.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d537077bdf8314b174d8196aac89c072693f5abd50cf91ac3ba8206d37b3a23e
|
|
| MD5 |
bc6975d96483a5303b631f4352c2376a
|
|
| BLAKE2b-256 |
4335c7dfad3a7d5124a1803cb25bb4def2288ac370aae194dda24c55f02ebd14
|
File details
Details for the file voxie-0.1.0-py3-none-any.whl.
File metadata
- Download URL: voxie-0.1.0-py3-none-any.whl
- Upload date:
- Size: 12.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
24bd4d2b664526e57e6a0c65c7909fceef6dff9b7075c332868559b291bef5f8
|
|
| MD5 |
ab1c4accad7c69d6149f8a564413d626
|
|
| BLAKE2b-256 |
31de092a630e347d1d63e4d28cdeca576025a4ca17cad34db172b8907e70757e
|