More doc cleanup and replacing django-sentry with raven

AUTHORS

@@ -1 +1 @@
-http://github.com/dcramer/django-sentry/contributors
+http://github.com/dcramer/raven/contributors

LICENSE

@@ -7,6 +7,6 @@ Redistribution and use in source and binary forms, with or without modification,
 
     2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-    3. Neither the name of the django-sentry nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+    3. Neither the name of the Raven nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

docs/conf.py

@@ -50,7 +50,7 @@
 #
 # The short X.Y version.
 
-version = __import__('pkg_resources').get_distribution('django-sentry').version
+version = __import__('pkg_resources').get_distribution('raven').version
 # The full version, including alpha/beta/rc tags.
 release = version
 

docs/config/django.rst

@@ -145,3 +145,35 @@ In some situations you may wish for a slightly different behavior to how Sentry
 this, Raven allows you to specify a custom client::
 
     SENTRY_CLIENT = 'raven.contrib.django.DjangoClient'
+
+Caveats
+-------
+
+Error Handling Middleware
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you already have middleware in place that handles ``process_exception`` you will need to take extra care when using Sentry.
+
+For example, the following middleware would suppress Sentry logging due to it returning a response::
+
+    class MyMiddleware(object):
+        def process_exception(self, request, exception):
+            return HttpResponse('foo')
+
+To work around this, you can either disable your error handling middleware, or add something like the following::
+
+    from django.core.signals import got_request_exception
+    class MyMiddleware(object):
+        def process_exception(self, request, exception):
+            # Make sure the exception signal is fired for Sentry
+            got_request_exception.send(sender=self, request=request)
+            return HttpResponse('foo')
+
+Or, alternatively, you can just enable Sentry responses::
+
+    from sentry.client.models import sentry_exception_handler
+    class MyMiddleware(object):
+        def process_exception(self, request, exception):
+            # Make sure the exception signal is fired for Sentry
+            sentry_exception_handler(request=request)
+            return HttpResponse('foo')

docs/config/logging.rst

@@ -29,7 +29,7 @@ A recommended pattern in logging is to simply reference the modules name for eac
     import logging
     logger = logging.getLogger(__name__)
 
-You can also use the ``exc_info`` and ``extra=dict(url=foo)`` arguments on your ``log`` methods. This will store the appropriate information and allow django-sentry to render it based on that information::
+You can also use the ``exc_info`` and ``extra=dict(url=foo)`` arguments on your ``log`` methods. This will store the appropriate information and allow Sentry to render it based on that information::
 
     logger.error('There was some crazy error', exc_info=True, extra={'url': request.build_absolute_uri()})
 

docs/contributing/index.rst

@@ -18,12 +18,9 @@ any base dependancies.
 ::
 
     virtualenv ~/.virtualenvs/sentry
-    source ~/.virtualenvs/sentry/bin/activate
+    source ~/.virtualenvs/raven/bin/activate
     python setup.py develop
 
-There are other optional dependancies, such as South, Haystack, and Eventlet, but
-they're not required to get a basic stack up and running.
-
 Running the Test Suite
 ----------------------
 
@@ -50,19 +47,10 @@ right at home.
     # Stop immediately on a failure
     python runtests.py --failfast
 
-::
-    
-    # Run only SentryRemoteTest
-    python runtests.py sentry.SentryRemoteTest
-
-::
-    
-    # Run only the testTimestamp test on SentryRemoteTest
-    python runtests.py sentry.SentryRemoteTest.testTimestamp
 
 Contributing Back Code
 ----------------------
 
 Ideally all patches should be sent as a pull request on GitHub, and include tests. If you're fixing a bug or making a large change the patch **must** include test coverage.
 
-You can see a list of open pull requests (pending changes) by visiting https://github.com/dcramer/django-sentry/pulls
+You can see a list of open pull requests (pending changes) by visiting https://github.com/dcramer/raven/pulls

docs/install/index.rst

@@ -4,11 +4,11 @@ Install
 
 If you haven't already, start by downloading Sentry. The easiest way is with *pip*::
 
-	pip install django-sentry --upgrade
+	pip install raven --upgrade
 
 Or with *setuptools*::
 
-	easy_install -U django-sentry
+	easy_install -U raven
 
 ------------
 Requirements
@@ -17,237 +17,4 @@ Requirements
 If you installed using pip or setuptools you shouldn't need to worry about requirements. Otherwise
 you will need to install the following packages in your Sentry server environment:
 
- - ``Django >= 1.2``
- - ``django-indexer >= 0.3.0`` (stores metadata indexes)
- - ``django-paging >= 0.2.4``
- - ``django-templatetag-sugar >= 0.1.0``
-
-.. note::
-
-   The built-in webserver's dependencies are not installed by default.
-
-You now have two choices:
-
-1. Run an integrated setup where your webapp runs both the Sentry client and server.
-
-   If you run on a single web server, or don't expect high load, this is the quickest
-   configuration to get up and running.
-
-2. (Recommended) Runs the server in a separate web instance to isolate your application.
-
-   The recommended setup for apps which have any kind of quality of service requirements.
-   Your Sentry server (web) application will run in its own environment which ensures the
-   most compatibility with your application, as well as ensuring it does not impact your
-   primary application servers.
-
-----------------
-Integrated Setup
-----------------
-
-The integrated setup is the easiest to get up and running. It simply requires you to plug the Sentry application into your existing
-Django project. Once installed, you simply need to update your settings.py and add ``sentry`` and ``sentry.client`` to ``INSTALLED_APPS``::
-
-	INSTALLED_APPS = (
-	    'django.contrib.admin',
-	    'django.contrib.auth',
-	    'django.contrib.contenttypes',
-	    'django.contrib.sessions',
-	    
-	    'sentry',
-	    'sentry.client',
-	    ...
-	)
-
-You will also need to add ``sentry.web.urls`` to your url patterns::
-
-	urlpatterns = patterns('',
-	    (r'^sentry/', include('sentry.web.urls')),
-	)
-
-We also highly recommend setting ``TEMPLATE_DEBUG=True`` in your environment (not to be confused with ``DEBUG``). This will allow
-Sentry to receive template debug information when it hits a syntax error.
-
-Finally, run ``python manage.py syncdb`` to create the database tables.
-
-.. note::
-
-   If you are using mod_wsgi/Apache, you will need to ensure that you set ``WSGIPassAuthorization On`` for the Sentry authentication to work.
-
-.. note::
-
-   We recommend using South for migrations. Initial migrations have already been created for Sentry in sentry/migrations/ so you only need to run ``python manage.py migrate sentry`` instead of ``syncdb``
-
-.. seealso::
-
-   See :doc:`../extensions` for information on additional plugins and functionality included.
-
-#########
-Upgrading
-#########
-
-Upgrading Sentry is fairly painless with South migrations. If you're not using South then you're on your own::
-
-	python manage.py migrate sentry
-
------------------------
-Running a Sentry Server
------------------------
-
-The recommended configuration of Sentry involves setting up a separate web server to handle your error
-logging. This means that any number of Sentry clients simply pass on this information to your primary Sentry
-server. If you run into a situation where one of Sentry's requirements conflict with your own, or you simply
-need to ensure quality of service within your project, this is for you.
-
-###################
-The Built-in Server
-###################
-
-Sentry provides a built-in webserver (powered by eventlet) to get you off the ground quickly. It's powered by two open source
-libraries, eventlet and python-daemon. To get started, you will need to manually install those dependicies::
-
-	easy_install eventlet>=0.9.15
-	easy_install python-daemon>=1.6
-
-Sentry provides the start, stop, and restart commands available via the command line interface to manage the server process::
-
-	# Sentry's server runs on port 9000 by default. Make sure your ``SENTRY_REMOTE_URL`` reflects
-	# the correct host and port!
-	sentry start --config=/etc/sentry.conf.py
-
-.. note::
-
-   The ``start`` command will also automatically run the ``upgrade`` command, which handles data and schema migrations.
-
-The configuration for the server is based on ``sentry.conf.server``, which contains a basic Django project configuration, as well
-as the default Sentry configuration values. It will use SQLite for the database, and Haystack using Whoosh. If you specify your own
-configuration via --config, you will likely want to preface the file with importing the global defaults::
-
-	#!/usr/bin/env python
-	# filename: /etc/sentry.conf.py
-	
-	DATABASES = {
-	    'default': {
-	        'ENGINE': 'django.db.backends.postgresql_psycopg2',
-	        'NAME': 'sentry',
-	        'USER': 'postgres',
-	        'PASSWORD': '',
-	        'HOST': '',
-	        'PORT': '',
-	    }
-	}
-	
-	SENTRY_LOG_FILE = '/var/log/sentry.log'
-        SENTRY_WEB_HOST = '0.0.0.0'
-	SENTRY_WEB_PORT = 9000
-
-By default, Sentry will also look for ``~/.sentry/sentry.conf.py`` and load it if it exists, and ``--config`` is not passed.
-
-.. note::
-
-   The default database is SQLite, which generally does not perform very well.
-
-The following settings are available for the built-in webserver:
-
-********
-WEB_HOST
-********
-
-The hostname which the webserver should bind to. Defaults to ``localhost``.
-
-********
-WEB_PORT
-********
-
-The port which the webserver should listen on. Defaults to ``9000``.
-
-************
-WEB_PID_FILE
-************
-
-The location to store the PID file. Defaults to ``/var/run/sentry.pid``.
-
-************
-WEB_LOG_FILE
-************
-
-The location to store the log file. Defaults to ``/var/log/sentry.log``.
-
-#############################
-Configuring a Sentry WSGI app
-#############################
-
-If you need more flexibility in your Sentry server, you may want to setup the server project manually. While this guide does not
-cover configuring your webserver, it does describe the required attributes of your WSGI app to run in a standalone server mode.
-
-First you're going to need to add Sentry to your server's INSTALLED_APPS::
-
-	INSTALLED_APPS = [
-	  ...
-	  'sentry',
-	  # We recommend adding the client to capture errors
-	  # seen on this server as well
-	  'sentry.client',
-	]
-
-You will also need to ensure that your ``SENTRY_KEY`` matches across your client and server configurations::
-
-	SENTRY_KEY = '0123456789abcde'
-
-
-######################
-Configure your Clients
-######################
-
-On each of your application servers, you will need to configure Sentry to communicate with your remote Sentry server.
-
-Start with adding the client to your ``INSTALLED_APPS``::
-
-	INSTALLED_APPS = [
-	  ...
-	  'sentry.client',
-	]
-
-Add the ``SENTRY_REMOTE_URL`` configuration variable, to point to the absolute location to the ``/store/`` view on your
-Sentry server::
-
-	# This should be the absolute URI of sentries store view
-	SENTRY_REMOTE_URL = 'http://your.sentry.server/sentry/store/'
-
-You will also need to ensure that your ``SENTRY_KEY`` matches across your client and server configurations::
-
-	SENTRY_KEY = '0123456789abcde'
-
-
--------
-Caveats
--------
-
-#########################
-Error Handling Middleware
-#########################
-
-If you already have middleware in place that handles ``process_exception`` you will need to take extra care when using Sentry.
-
-For example, the following middleware would suppress Sentry logging due to it returning a response::
-
-	class MyMiddleware(object):
-	    def process_exception(self, request, exception):
-	        return HttpResponse('foo')
-
-To work around this, you can either disable your error handling middleware, or add something like the following::
-
-	from django.core.signals import got_request_exception
-	class MyMiddleware(object):
-	    def process_exception(self, request, exception):
-	        # Make sure the exception signal is fired for Sentry
-	        got_request_exception.send(sender=self, request=request)
-	        return HttpResponse('foo')
-
-Or, alternatively, you can just enable Sentry responses::
-
-	from sentry.client.models import sentry_exception_handler
-	class MyMiddleware(object):
-	    def process_exception(self, request, exception):
-	        # Make sure the exception signal is fired for Sentry
-	        sentry_exception_handler(request=request)
-	        return HttpResponse('foo')
+ - ``simplejson``

raven/__init__.py

@@ -10,7 +10,7 @@
 
 try:
     VERSION = __import__('pkg_resources') \
-        .get_distribution('django-sentry').version
+        .get_distribution('raven').version
 except Exception, e:
     VERSION = 'unknown'