Metadata-Version: 2.1
Name: bugsplat
Version: 0.2.0
Summary: A Python package for sending Unhandled Exceptions to BugSplat
Home-page: https://github.com/BugSplat-Git/bugsplat-py
Author: BugSplat
Author-email: support@bugsplat.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/BugSplat-Git/bugsplat-py/issues
Project-URL: BugSplat, https://www.bugsplat.com
Description: # bugsplat-py
        
        A BugSplat integration for reporting Unhandled Exceptions in Python.
        
        ## Installing
        Install the bugsplat package using pip
        ```shell
        pip install bugsplat
        ```
        
        ## Usage
        1. Import the BugSplat class
        ```python
        from bugsplat import BugSplat
        ```
        2. Create a new BugSplat instance passing it the name of your BugSplat database, application and version
        ```python
        bugsplat = BugSplat(database, application, version)
        ```
        3. Optionally, you set default values for appKey, description, email, user and additionaFilePaths
        ```python
        bugsplat.setDefaultAppKey('key!')
        bugsplat.setDefaultDescription('description!')
        bugsplat.setDefaultEmail('fred@bugsplat.com')
        bugsplat.setDefaultUser('Fred')
        bugsplat.setDefaultAdditionalFilePaths([
            additionalFilePath,
            additionalFilePath2
        ])
        ```
        4. Wrap your application code in a try except block. In the except block call post. You can override any of the default properties that were set in step 3
        ```python
        try:
            crash()
        except Exception as e:
            bugsplat.post(e, additionalFilePaths=[], appKey='other key!', description='other description!', email='barney@bugsplat.com', user='Barney')
        ```
        5. Once you've posted a crash, navigate to the Crashes page and click the link in the ID column to be see the crash's details
        
        Thanks for using BugSplat ❤️
Keywords: crash,reporting,bugsplat,unhandled,exception,diagnostics,debug,debugging,stack,trace
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
