Stalk StackOverflow.
Project description
"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.
Installation
Using Pip
For Linux and Mac OS.
$ sudo pip3 install debuggy
For Windows OS.
$ pip install debuggy[win]
Apt Install
$ sudo apt install python3-debuggy
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
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
Command line
Debuggy comes with a CLI tool . You can use it as such:
USAGE: DeBuggy [-h] [-v] [-s SCRIPT] [-q QUERY] {call,editor,s,q} ...
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,editor,s,q}
optional arguments:
-h, --help show this help message and exit
-v, --version show programs version number and exit
-s SCRIPT, --script SCRIPT , s SCRIPT
Run Script from Terminal
-q QUERY, --query QUERY , q QUERY
Query stackoverflow with Error message
editor
Open Terminal Editor
$ debuggy q concurency in python
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 s test.py
Debuggy also comes with a terminal IDE which can be used to write codes for different languages.This can be accessed by using the command
$ debuggy editor
$ debuggy editor test.py
Debuggy TUI Commands
- DOWN ARROW KEY (↓) - HIGHLIGHT NEXT LINE
- UP ARROW KEY (↑) - HIGHLIGHT PREVIOUS LINE
- ENTER KEY (enter) - SELECT HIGHLIGHTED LINE | OPEN QUESTION PAGE
- LOWERCASE q KEY (q) - QUIT CURRENT VIEW | QUIT TUI
- ESCAPE,BACKSPACE KEYS (esc,backspace) - MOVE BACK TO PREVIOUS VIEW
- LOWERCASE b KEY (b) - OPENS CURRENT HIGHLIGHTED LINK IN BROWSER
WHILE IN STACKOVERFLOW QUESTION PAGE:
- (→) and (←) MOVES BETWEEN ANSWERS AND DESCRIPTIONS
- RIGHT ARROW KEY (→) - NEXT PAGE VIEW
- LEFT ARROW KEY (←) - PREVIOUS PAGE VIEW
- LOWERCASE e KEY (e) - EXPORT CODES FROM ANSWERS TO CLIPBOARD OR SCRIPT IF PRESENT | OPENS EXPORT MENU
WHILE IN CODES TO EXPORT MENU:
- LOWERCASE c KEY (c)- COPY CODE TO CLIPBOARD
- ENTER KEY (enter) - SELECT HIGHLIGHTED LINE | OPEN EDITOR IF SCRIPT IS PRESENT ELSE COPIES CODE SNIPPET TO CLIPBOARD
Debuggy Editor Commands
The Editor has two modes, Normal and Insert modes. It Opens in normal mode by default.
- DOWN ARROW KEY (↓) - MOVE CURSOR TO NEXT LINE
- UP ARROW KEY (↑) - MOVE CURSOR TO PREVIOUS LINE
- RIGHT ARROW KEY (→) - MOVE CURSOR RIGHT
- LEFT ARROW KEY (←) - MOVE CURSOR LEFT
KEY PRESS ACTIONS IN NORMAL MODE:
- LOWERCASE w KEY (w) - WRITE TO FILE (Editor should be initialized with a filename)
- LOWERCASE a KEY (a) - Enter Insert mode after cursor position
- LOWERCASE i KEY (i) - Enter Insert mode
- LOWERCASE x KEY (x) - Delete a character
- KEY DOLLAR SIGN ($) - Move to end of line
- KEY ZERO (0) - Move to beginning of line
- UPPERCASE O KEY (O) - Enter and Insert line before current
- LOWERCASE o KEY (o) - Enter and Insert line after current
- LOWERCASE q KEY (q) - Quit Editor
KEY PRESS ACTIONS IN INSERT MODE:
- KEY BACKSPACE (backspace) - REMOVES PREVIOUS CHARACTER
- KEY ESCAPE (esc) - EXITS INSERT MODE AND RETURNS TO NORMAL MODE
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
Credits:
Distributed under the MIT license. See LICENSE for more information.
- Eje Daniel - author/maintainer
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
File details
Details for the file debuggy-3.0.1.tar.gz
.
File metadata
- Download URL: debuggy-3.0.1.tar.gz
- Upload date:
- Size: 21.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45e482e3757d73b445eb06c5e695acefb885b4378a6f6590cb36a3fe90ed0f3f |
|
MD5 | f5b5ad44e4171cb761757ec8934e313c |
|
BLAKE2b-256 | 2161a75e943408f31176cf712de3d910fc1852e54e7f3d2600a5af35608e501f |
File details
Details for the file debuggy-3.0.1-py3-none-any.whl
.
File metadata
- Download URL: debuggy-3.0.1-py3-none-any.whl
- Upload date:
- Size: 24.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad1c999055f73be8f79ec05ff51e962fe88f3a53a725e40613f21254d7c0f083 |
|
MD5 | e2260d71f891a5600d884f9573e834c7 |
|
BLAKE2b-256 | 7e3d98b643339a7b72e82d7a5f489f97554e84e1f5cb67595290276c8ea57722 |