README.rst
1.. raw:: html
2
3 <p align="center">
4 <a href="https://sentry.io" target="_blank" align="center">
5 <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
6 </a>
7 <br>
8 </p>
9
10Raven - Sentry for Python
11=========================
12
13.. image:: https://img.shields.io/pypi/v/raven.svg
14 :target: https://pypi.python.org/pypi/raven
15 :alt: PyPi page link -- version
16
17.. image:: https://travis-ci.org/getsentry/raven-python.svg?branch=master
18 :target: https://travis-ci.org/getsentry/raven-python
19
20.. image:: https://img.shields.io/pypi/l/raven.svg
21 :target: https://pypi.python.org/pypi/raven
22 :alt: PyPi page link -- MIT licence
23
24.. image:: https://img.shields.io/pypi/pyversions/raven.svg
25 :target: https://pypi.python.org/pypi/raven
26 :alt: PyPi page link -- Python versions
27
28.. image:: https://codeclimate.com/github/getsentry/raven-python/badges/gpa.svg
29 :target: https://codeclimate.com/github/getsentry/raven-python
30 :alt: Code Climate
31
32
33Raven is the official legacy Python client for `Sentry`_, officially supports
34Python 2.6–2.7 & 3.3–3.7, and runs on PyPy and Google App Engine.
35
36**This SDK is being phased out for** `Sentry-Python <https://github.com/getsentry/sentry-python>`_.
37
38It tracks errors and exceptions that happen during the
39execution of your application and provides instant notification with detailed
40information needed to prioritize, identify, reproduce and fix each issue.
41
42It provides full out-of-the-box support for many of the popular python frameworks, including
43Django, and Flask. Raven also includes drop-in support for any WSGI-compatible
44web application.
45
46Your application doesn't live on the web? No problem! Raven is easy to use in
47any Python application.
48
49For more information, see our `Python Documentation`_ for framework integrations and other goodies.
50
51
52Features
53--------
54
55- Automatically report (un)handled exceptions and errors
56- Send customized diagnostic data
57- Process and sanitize data before sending it over the network
58
59
60Quickstart
61----------
62
63It's really easy to get started with Raven. After you complete setting up a project in Sentry,
64you’ll be given a value which we call a DSN, or Data Source Name. You will need it to configure the client.
65
66
67Install the latest package with *pip* and configure the client::
68
69 pip install raven --upgrade
70
71Create a client and capture an example exception:
72
73.. sourcecode:: python
74
75 from raven import Client
76
77 client = Client('___DSN___')
78
79 try:
80 1 / 0
81 except ZeroDivisionError:
82 client.captureException()
83
84
85Raven Python is more than that however. Checkout our `Python Documentation`_.
86
87
88Contributing
89------------
90
91Raven will continue to be maintained for bugfixes and contributions are more than welcome! New features should only go into the new sentry-python SDK.
92
93There are many ways to contribute:
94
95* Join in on discussions on our `Mailing List`_ or in our `IRC Channel`_.
96
97* Report bugs on our `Issue Tracker`_.
98
99* Submit a pull request!
100
101
102Resources
103---------
104
105* `Sentry`_
106* `Python Documentation`_
107* `Issue Tracker`_
108* `Code`_ on Github
109* `Mailing List`_
110* `IRC Channel`_ (irc.freenode.net, #sentry)
111* `Travis CI`_
112
113.. _Sentry: https://getsentry.com/
114.. _Python Documentation: https://docs.getsentry.com/hosted/clients/python/
115.. _SDKs for other platforms: https://docs.sentry.io/#platforms
116.. _Issue Tracker: https://github.com/getsentry/raven-python/issues
117.. _Code: https://github.com/getsentry/raven-python
118.. _Mailing List: https://groups.google.com/group/getsentry
119.. _IRC Channel: irc://irc.freenode.net/sentry
120.. _Travis CI: http://travis-ci.org/getsentry/raven-python
121
122
123
124
125
126Not using Python? Check out our `SDKs for other platforms`_.
127
