Skip to main content

Django health check and test-that-it-works application.

Project description

# Django Doctor

django-doctor is a Django pluggable app for checking the operational status of
a Django installation. It includes checking that caching and storage is
correctly set up, that email is working, etc.

This is an early draft, so use it at your own risk.


## Installation

Install `django-doctor` (available on PyPi):

pip install django-doctor

Add it to `INSTALLED_APPS` in your `settings.py` (so Django can locate template):

INSTALLED_APPS += ['doctor']

And add it to your root URLconf:

urlpatterns = patterns('',
url(r'^doctor/', include('doctor.urls')),
...
)


## Settings

These are the available configurable settings, along with their default values:

<table>
<tr>
<th align="left">Name</th>
<th align="left">Default</th>
<th align="left">Description</th>
</tr>
<tr>
<td><code>DOCTOR_BASE_TEMPLATE</code></td>
<td><code>'base.html'</code></td>
<td>The template all the doctor templates should inherit from</td>
</tr>
<tr>
<td><code>DOCTOR_SERVICES</code></td>
<td>
<code>'doctor.services.cache.CacheServiceCheck',
'doctor.services.celery.CeleryServiceCheck',
'doctor.services.email.EmailServiceCheck',
'doctor.services.storage.StorageServiceCheck',</code></td>
<td>Paths to service check classes.</td>
</tr>
</table>

## Services

We are working on making a pluggable structure for the service check, work in progress.
Checks for cache and Sentry are currently included by default.


## Tests

Run unit tests by running <code>python setup.py test</code>


## TODO

* Set up so the tests can run standalone
* Include the mgmt commands in views?
* Implement more health checks:
* Databases
* Celery
* Haystack
* Storage
* Email
* Sentry?

Project details


Release history Release notifications

History Node

0.4.0

History Node

0.3.0

History Node

0.2.6

History Node

0.2.5

History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.0

This version
History Node

0.1.9

History Node

0.1.8

History Node

0.1.7

History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-doctor-0.1.9.tar.gz (10.3 kB) Copy SHA256 hash SHA256 Source None Sep 24, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page