Skip to main content

Stalk StackOverflow.

Reason this release was yanked:

Bugs Fix

Project description

CircleCI CircleCI PyPI version Coverage Status

"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"

Demo Query

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

Demo Script

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 git@github.com: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

Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

debuggy-1.0.tar.gz (11.4 kB view hashes)

Uploaded Source

Built Distributions

debuggy-1.0-py3.7.egg (26.1 kB view hashes)

Uploaded Source

debuggy-1.0-py3-none-any.whl (14.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page