bugsplat 1.0.2

Description:

bugsplat 1.0.2

BugSplat
Crash and error reporting built for busy developers.








👋 Introduction
This repo contains the source code for bugsplat-py, a BugSplat integration for reporting Unhandled Exceptions in Python.
🏗 Installation
Install the bugsplat package using pip
pip install bugsplat

⚙️ Configuration

Import the BugSplat class

from bugsplat import BugSplat


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

bugsplat = BugSplat(database, application, version)


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

bugsplat.set_default_app_key('key!')
bugsplat.set_default_description('description!')
bugsplat.set_default_email('[email protected]')
bugsplat.set_default_user('Fred')
bugsplat.set_default_additional_file_paths([
'./path/to/additional-file.txt',
'./path/to/additional-file-2.txt'
])


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,
additional_file_paths=[],
app_key='other key!',
description='other description!',
email='[email protected]',
user='Barney'
)


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


🧑‍💻 Development
To configure a development environment:

Clone the repository

git clone https://github.com/BugSplat-Git/bugsplat-py.git


Create a virtual environment

python -m venv venv


Activate the virtual environment

# unix/macos
source venv/bin/activate

# windows
.\env\Scripts\activate


Install the project's dependencies

pip install .

Thanks for using BugSplat ❤️

License

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Share

• Share on Facebook
• Share on Twitter