Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

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

Project description

# Django Doctor

django-doctor is a Django pluggable application 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 `` (so Django can locate

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:

<th align="left">Name</th>
<th align="left">Default</th>
<th align="left">Description</th>
<td>The template all the doctor templates should inherit from</td>
<td>Paths to service check classes.</td>
<td>Paths to storage classes to check.</td>

## Services

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

## Tests

Run unit tests by running <code>python test</code>


* Set up the project tests so they can run standalone
* Refine the service class approach
* Include sending of test email in a view?
* Implement more health checks:
* Databases
* Haystack?
* Sentry?
* request.is_secure() is properly set up

Project details

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.4.0.tar.gz (10.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

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