skip to navigation
skip to content

Not Logged In

django-doctor 0.2.3

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

Latest Version: 0.3.0

# 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 `settings.py` (so Django can locate
templates):

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:






















Name Default Description
DOCTOR_BASE_TEMPLATE 'base.html' The template all the doctor templates should inherit from
DOCTOR_SERVICES
'doctor.services.cache.CacheServiceCheck',

'doctor.services.celery_check.CeleryServiceCheck',

'doctor.services.email.EmailServiceCheck',

'doctor.services.storage.StorageServiceCheck',
Paths to service check classes.
DOCTOR_STORAGE_CLASSES
settings.DEFAULT_FILE_STORAGE,

settings.STATICFILES_STORAGE,
Paths to storage classes to check.



## 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 python setup.py test


## TODO

* 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  
File Type Py Version Uploaded on Size
django-doctor-0.2.3.tar.gz (md5) Source 2012-10-12 10KB
  • Downloads (All Versions):
  • 69 downloads in the last day
  • 594 downloads in the last week
  • 2305 downloads in the last month