# Quickstart
[![Documentation Status](https://readthedocs.org/projects/sentrypy/badge/?version=latest)](https://sentrypy.readthedocs.io/en/latest/?badge=latest)
![black passing](https://github.com/perfect-operations/sentrypy/actions/workflows/black.yml/badge.svg)
![pytest passing](https://github.com/perfect-operations/sentrypy/actions/workflows/pytest.yml/badge.svg)
![PyPI - Version](https://img.shields.io/pypi/v/sentrypy)
![PyPI - License](https://img.shields.io/pypi/l/sentrypy)
[Sentry.io](https://sentry.io/) is an error tracking platform that helps you monitor and
resolve issues in real-time.
[sentrypy](https://github.com/perfect-operations/sentrypy) is a Python wrapper for
the Sentry API to:
- Retrieve error data
- Automate incident responses
- Integrate with your workflow
## Installation
First create a sentry token ([official tutorial](https://docs.sentry.io/api/guides/create-auth-token/)).
Then install by one of the options below.
##### Installing from PyPI
```
pip install sentrypy
```
##### Installing from source
```
git clone git@github.com:perfect-operations/sentrypy.git
pip install -e sentrypy
```
## Usage
```python
from sentrypy import Sentry
# Connect to Sentry API
sentry = Sentry(token="your-secret-token")
# Retrieve a project
org = sentry.organization("your-org-slug")
project = org.project("your-project-slug")
# Inspect the issues
for issue in project.issues():
print(issue.title)
```
Example output:
```
IndexError: list index out of range
WebDriverException: Message: unknown error: session deleted because of page crash
AttributeError: 'NoneType' object has no attribute 'startswith'
```
Do this and much more. Install and explore!
## Documentation
Read the full documentation [on ReadTheDocs](https://sentrypy.readthedocs.io/en/latest/).
## Feature Requests & Issues
Please let me know [here on GitHub](https://github.com/perfect-operations/sentrypy/issues)!
## Support
* Write me [on Twitter](https://twitter.com/drpaulw)
* Write me [on LinkedIn](https://www.linkedin.com/in/drpaulw)
Raw data
{
"_id": null,
"home_page": "https://github.com/perfect-operations/sentrypy",
"name": "sentrypy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "sentry api wrapper pythonic",
"author": "Paul Weber",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/20/4f/8156367e6936c8e768573246e649c06828bdcbe9c00f09575aedf50332b8/sentrypy-0.1.8.tar.gz",
"platform": null,
"description": "# Quickstart\n\n[![Documentation Status](https://readthedocs.org/projects/sentrypy/badge/?version=latest)](https://sentrypy.readthedocs.io/en/latest/?badge=latest)\n![black passing](https://github.com/perfect-operations/sentrypy/actions/workflows/black.yml/badge.svg)\n![pytest passing](https://github.com/perfect-operations/sentrypy/actions/workflows/pytest.yml/badge.svg)\n![PyPI - Version](https://img.shields.io/pypi/v/sentrypy)\n![PyPI - License](https://img.shields.io/pypi/l/sentrypy)\n\n[Sentry.io](https://sentry.io/) is an error tracking platform that helps you monitor and\nresolve issues in real-time.\n\n[sentrypy](https://github.com/perfect-operations/sentrypy) is a Python wrapper for\nthe Sentry API to:\n\n- Retrieve error data\n- Automate incident responses\n- Integrate with your workflow\n\n## Installation\n\nFirst create a sentry token ([official tutorial](https://docs.sentry.io/api/guides/create-auth-token/)).\n\nThen install by one of the options below.\n\n##### Installing from PyPI\n```\npip install sentrypy\n```\n\n##### Installing from source\n```\ngit clone git@github.com:perfect-operations/sentrypy.git\npip install -e sentrypy\n```\n\n## Usage\n\n```python\nfrom sentrypy import Sentry\n\n# Connect to Sentry API\nsentry = Sentry(token=\"your-secret-token\")\n\n# Retrieve a project\norg = sentry.organization(\"your-org-slug\")\nproject = org.project(\"your-project-slug\")\n\n# Inspect the issues\nfor issue in project.issues():\n print(issue.title)\n```\nExample output:\n```\nIndexError: list index out of range\nWebDriverException: Message: unknown error: session deleted because of page crash\nAttributeError: 'NoneType' object has no attribute 'startswith'\n```\n\nDo this and much more. Install and explore!\n\n## Documentation\nRead the full documentation [on ReadTheDocs](https://sentrypy.readthedocs.io/en/latest/).\n\n## Feature Requests & Issues\nPlease let me know [here on GitHub](https://github.com/perfect-operations/sentrypy/issues)!\n\n## Support\n* Write me [on Twitter](https://twitter.com/drpaulw)\n* Write me [on LinkedIn](https://www.linkedin.com/in/drpaulw)\n\n\n",
"bugtrack_url": null,
"license": "LGPL-2.1",
"summary": "The pythonic API wrapper for Sentry.io",
"version": "0.1.8",
"project_urls": {
"Documentation": "https://sentrypy.readthedocs.io/en/latest/",
"Homepage": "https://github.com/perfect-operations/sentrypy",
"Source": "https://github.com/perfect-operations/sentrypy"
},
"split_keywords": [
"sentry",
"api",
"wrapper",
"pythonic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d685cb8a4329b91dd027b2c4d70ba7441e00f1ac22c4da9ec3f4d2efef8d903a",
"md5": "788d2be2657347d6452fb8fc092889f8",
"sha256": "202dd7348a5a49061d2948ab0c4e3ef2494897f014330bc28be112bb3b722f44"
},
"downloads": -1,
"filename": "sentrypy-0.1.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "788d2be2657347d6452fb8fc092889f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 19250,
"upload_time": "2023-11-17T15:55:46",
"upload_time_iso_8601": "2023-11-17T15:55:46.144303Z",
"url": "https://files.pythonhosted.org/packages/d6/85/cb8a4329b91dd027b2c4d70ba7441e00f1ac22c4da9ec3f4d2efef8d903a/sentrypy-0.1.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "204f8156367e6936c8e768573246e649c06828bdcbe9c00f09575aedf50332b8",
"md5": "378d273dd6347548f3e7bd0f84a3415a",
"sha256": "95a6ff58eb85f9536829b218b9583543d59c039eb8a2bff3aca8671b68416281"
},
"downloads": -1,
"filename": "sentrypy-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "378d273dd6347548f3e7bd0f84a3415a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8442,
"upload_time": "2023-11-17T15:55:47",
"upload_time_iso_8601": "2023-11-17T15:55:47.878000Z",
"url": "https://files.pythonhosted.org/packages/20/4f/8156367e6936c8e768573246e649c06828bdcbe9c00f09575aedf50332b8/sentrypy-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-17 15:55:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "perfect-operations",
"github_project": "sentrypy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sentrypy"
}