Metadata-Version: 2.1
Name: py-bugs
Version: 1
Summary: The all-in-one Python debugging solution
Home-page: https://github.com/Alex-Jando/PyBug
Author: Alex-Jando
Author-email: alexjando2007@outlook.com
Project-URL: Bug Tracker, https://github.com/Alex-Jando/PyBug/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# PyBug
*The all-in-one Python debugging solution*
#
## Features
- Points out errors in your Python scripts
- Finds articles that can help you solve the error
- Allows you to search for articles related to any question you may have

## Installation / Setup
- Install **PyBug** using pip by typing `pip install py-bugs` in your terminal
- Open a new python file once **PyBug** is installed
- At the begining of the file type the following:
```
import pybug
pybug.init(__file__)
```
- `__file__` can be replaced with `sys.argv[0]` or `sys.executable` to make **PyBug** work with pyinstaller
- Once you've done that **PyBug** is completely installed
- If you ever want to stop **PyBug**, you can simply just comment out `pybug.init(__file__)`
- If you want to keep **PyBug** running but you don't want to see the links, change `pybug.init(__file__)` to `pybug.init(__file__, debug = False)`

## Using **PyBug**
- **PyBug** is very simple to use, and for the most part, just runs in the background
- **PyBug** has three main functions
  - `init(__file__)` which just makes **PyBug** run when the file starts
  - `search(query)` which takes a query and will return a list of useful links related to your query
  - `error(error)` which will take an `Exception`, then find useful links related to it
  
## Contribute
- Please feel free to contribute by forking and adding any features you want
- Also if you have any ideas that you want to add, but don't know how comment it somewhere
