bugsplat 0.1.0

A Python package for sending Unhandled Exceptions to BugSplat

bugsplat-py

A BugSplat integration for reporting Unhandled Exceptions in Python.

Installing

Install the bugsplat package using pip

pip install bugsplat

Usage

1. Import the BugSplat class

from bugsplat import BugSplat

2. Create a new BugSplat instance passing it the name of your BugSplat database, application and version

bugsplat = BugSplat(database, application, version)

3. Optionally, you set default values for appKey, description, email, user and additionaFilePaths

bugsplat.setDefaultAppKey('key!')
bugsplat.setDefaultDescription('description!')
bugsplat.setDefaultEmail('[e-mail]')
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

try:
    crash()
except Exception as e:
    bugsplat.post(e, additionalFilePaths=[], appKey='other key!', description='other description!', email='[e-mail]', 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 ❤️