Metadata-Version: 2.1
Name: codebuddy
Version: 0.0.2
Summary: stack overflow search on exception
Home-page: https://github.com/0x44RU5H/codebuddy
Author: Aarush Gupta
Author-email: aarush@theaarushgupta.com
License: AGPLv3+
Description: <p align = "center">
            <a href = "https://opensource.org/licenses/MIT">
                <img alt = "License" src = "https://img.shields.io/badge/License-AGPLv3-green.svg">
            </a>
            <a href = "https://pypi.org/project/codebuddy/">
                <img alt = "Version" src = "https://img.shields.io/pypi/v/codebuddy.svg">
            </a>
            <a href = "https://pypi.org/project/codebuddy/">
                <img alt = "Downloads" src = "https://img.shields.io/pypi/dm/codebuddy.svg">
            </a>
            <a href = "https://pypi.org/project/codebuddy/">
                <img alt = "Supported Versions" src = "https://img.shields.io/pypi/pyversions/codebuddy.svg">
            </a>
        </p>
        
        <h1 align = "center"><a href = "https://pypi.org/project/codebuddy/">CodeBuddy <code>v0.0.1</code></a></h1>
        <h3 align = "center">stack overflow search on exception</h3>
        
        # Overview
        
        `codebuddy` is a tool for python programmers. On exceptions, it uses the stack overflow public api to search for top answers and returns them in a neat fashion, along with traceback information for debug information.
        
        # Examples
        
        ## Basic Usage
        
        ``` python
        from codebuddy import codebuddy
        
        def main():
            print(7 + "3") # <= that's illegal
        
        codebuddy(main)
        ```
        
        This code returns an error, which `codebuddy` catches and gets stack overflow answers for.
        
        ```
        $ python3 main.py
        
        Traceback (most recent call last):
          File "/home/aarushgupta/fun/codebuddy/codebuddy/__init__.py", line 6, in codebuddy
            function()
          File "test.py", line 4, in bob
            print(7 + "3")
        TypeError: unsupported operand type(s) for +: 'int' and 'str'
        
        ========================================
        
        Exception caught by CodeBuddy: TypeError
        ----------------------------------------
        
        Stack Overflow search results:
        
        1. TypeError: unsupported operand type(s) for /: 'int' and 'str'
           This code isn't working and keeps giving the error message in the title
           URL to question: https://stackoverflow.com/questions/69506027/typeerror-unsupported-operand-types-for-int-and-str
        
        ...
        ```
        
        Very neat indeed! The user also gets the description and url to the question in the results as well.
        
        ## Advanced Usage
        
        `codebuddy` also supports arguments
        
        ``` python
        from codebuddy import codebuddy
        
        def main(number: int):
            print(number + "3") # <= that's still illegal
        
        codebuddy(main, arguments = [1]) # executes function as "main(1)"
        ```
        
        # Copyright &copy; 2021 Aarush Gupta
        This code is copyrighted but licensed to the public under the GNU AGPLv3 license and any later versions.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
