{"id":25836015,"url":"https://github.com/bugsplat-git/bugsplat-py","last_synced_at":"2025-07-07T00:08:39.861Z","repository":{"id":37839202,"uuid":"353684835","full_name":"BugSplat-Git/bugsplat-py","owner":"BugSplat-Git","description":"🐛🐍💥 BugSplat error reporting integration for Python","archived":false,"fork":false,"pushed_at":"2024-12-03T02:44:26.000Z","size":35,"stargazers_count":6,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-07T08:04:41.570Z","etag":null,"topics":["bugsplat","error-reporting","exception-reporting","python"],"latest_commit_sha":null,"homepage":"https://docs.bugsplat.com/introduction/getting-started/integrations/cross-platform/python","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BugSplat-Git.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-04-01T11:59:58.000Z","updated_at":"2024-10-09T22:11:14.000Z","dependencies_parsed_at":"2025-06-07T08:04:43.491Z","dependency_job_id":"5554f15e-969d-4f34-9d20-8f47b2053690","html_url":"https://github.com/BugSplat-Git/bugsplat-py","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/BugSplat-Git/bugsplat-py","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fbugsplat-py","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fbugsplat-py/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fbugsplat-py/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fbugsplat-py/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BugSplat-Git","download_url":"https://codeload.github.com/BugSplat-Git/bugsplat-py/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BugSplat-Git%2Fbugsplat-py/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263991505,"owners_count":23540667,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bugsplat","error-reporting","exception-reporting","python"],"created_at":"2025-03-01T01:38:52.357Z","updated_at":"2025-07-07T00:08:39.828Z","avatar_url":"https://github.com/BugSplat-Git.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![bugsplat-github-banner-basic-outline](https://user-images.githubusercontent.com/20464226/149019306-3186103c-5315-4dad-a499-4fd1df408475.png)](https://bugsplat.com)\n\u003cbr/\u003e\n# \u003cdiv align=\"center\"\u003eBugSplat\u003c/div\u003e \n### **\u003cdiv align=\"center\"\u003eCrash and error reporting built for busy developers.\u003c/div\u003e**\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://twitter.com/BugSplatCo\"\u003e\n        \u003cimg alt=\"Follow @bugsplatco on Twitter\" src=\"https://img.shields.io/twitter/follow/bugsplatco?label=Follow%20BugSplat\u0026style=social\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://discord.gg/K4KjjRV5ve\"\u003e\n        \u003cimg alt=\"Join BugSplat on Discord\" src=\"https://img.shields.io/discord/664965194799251487?label=Join%20Discord\u0026logo=Discord\u0026style=social\"\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n## 👋 Introduction\n\nThis repo contains the source code for [bugsplat-py](https://github.com/BugSplat-Git/bugsplat-py), a BugSplat integration for reporting Unhandled Exceptions in Python.\n\n## 🏗 Installation\n\nBugSplat recommends you use [bugsplat-py](https://github.com/BugSplat-Git/bugsplat-py) with a Python [virtual environment](https://docs.python.org/3/library/venv.html). To create a virtual environment for your project please run the following command at your project's root directory:\n\n```shell\npython -m venv venv\n```\n\nActivate your virtual environment by running the following command:\n\n```shell\n# unix/macos\nsource venv/bin/activate\n\n# windows\n.\\env\\Scripts\\activate\n```\n\nInstall the [bugsplat](https://pypi.org/project/bugsplat) package using pip:\n\n```bash\npip install bugsplat\n```\n\n## ⚙️ Configuration\n\n1. Import the BugSplat class\n```python\nfrom bugsplat import BugSplat\n```\n\n2. Create a new BugSplat instance passing it the name of your BugSplat database, application and version\n\n```python\nbugsplat = BugSplat(database, application, version)\n```\n\n3. Optionally, you set default values for appKey, description, email, user and additionaFilePaths\n\n```python\nbugsplat.set_default_app_key('key!')\nbugsplat.set_default_description('description!')\nbugsplat.set_default_email('fred@bugsplat.com')\nbugsplat.set_default_user('Fred')\nbugsplat.set_default_additional_file_paths([\n    './path/to/additional-file.txt',\n    './path/to/additional-file-2.txt'\n])\n```\n\n4. 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\n\n```python\ntry:\n    crash()\nexcept Exception as e:\n    bugsplat.post(\n        e,\n        additional_file_paths=[],\n        app_key='other key!',\n        description='other description!',\n        email='barney@bugsplat.com',\n        user='Barney'\n    )\n```\n\n5. 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\n\n\u003cimg width=\"1713\" alt=\"BugSplat Crash Page\" src=\"https://user-images.githubusercontent.com/2646053/175091507-32a9c505-1d26-4d5b-aef7-44b5a347ddb4.png\"\u003e\n\n## 🧑‍💻 Development\n\nTo configure a development environment:\n\n1. Clone the repository\n\n```shell\ngit clone https://github.com/BugSplat-Git/bugsplat-py.git\n```\n\n2. Create a virtual environment\n\n```shell\npython -m venv .venv\n```\n\n3. Activate the virtual environment\n\n```shell\n# unix/macos\nsource .venv/bin/activate\n\n# windows\n.\\.venv\\Scripts\\activate\n```\n\n4. Install the project's dependencies\n\n```shell\npip install .\n```\n\nThanks for using BugSplat ❤️\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugsplat-git%2Fbugsplat-py","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbugsplat-git%2Fbugsplat-py","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbugsplat-git%2Fbugsplat-py/lists"}