"Stalk Overflow with
debuggy
"
Error Parser
Everything is done in Python so it's extremely easy to install and use. Supports Python 3. Debuggy is used to execute scripts, it creates a wrap around the script with the help of sub processes, and listens for errors, capturing and parsing them through popular discussion forums. This is then styled and displayed on the terminal with the help of python curses.
Usage
Simple Example: By importing debuggy as the first (1st) line of your python script, it keeps track of the scripts run time and parses any error message encountered.
>>> import debuggy
You can also use debuggy comments to add comments to your code and make debugging earsier. Comments can be made before functions, classes and declaration of variables stating the function of the preceeding code block, if an error occurs withing the code block the comment is used to track proceedures to execute the function properly.
>>> from debuggy import comment
>>> comment('function to add two numbers')
>>> def Add (x,y):
return x + y
The type of preceeding code block can also be specified ,whether it is a function,class or variable using the 'type' argument with either 'func','class','var' as the type parameter.
>>> from debuggy import comment
>>> comment(comment = 'function to add two numbers' ,type='func')
>>> def Add (x,y):
return x + y
Installation
$ pip install debuggy
or apt-get if you're using Linux:
$ sudo apt-get install debuggy
Command line
Debuggy comes with a CLI tool . You can use it as such:
$ debuggy --query "how to use loops"
Supported file types: Python, Node.js, Ruby, Golang, and Java. These can be parsed into debuggy to track Errors by using the --script command.
$ debuggy --script test.py
USAGE: DeBuggy [-h] [-v] [-s SCRIPT] [-q QUERY] {call} ...
Command-line tool that automatically searches Google and displays results in
your terminal when you get a compiler error. Made by @Derhnyel
positional arguments:
{call}
optional arguments:
-h, --help show this help message and exit
-v, --version show programs version number and exit
-s SCRIPT, --script SCRIPT
Run Script from Terminal
-q QUERY, --query QUERY
Query stackoverflow with Error message
Manually building from source
- Install Python tools 3+ - (https://www.python.org/downloads/)
- Clone this repo
git clone [email protected]:derhnyel/deBuggy.git
- Run unit tests with
make test
- Build and install:
make install
Contributing
Want to contribute to Debuggy? Awesome! Check out the contributing guidelines to get involved.
Pending Features:
- Add Commenting feature
- Search result Optimization
- Add Support for more languages
Meta
Inspired by Shobrook Repository Rebound.
Distributed under the MIT license. See LICENSE for more information.
- Eje Daniel - author/maintainer