Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 1.26 KB

README.rst

File metadata and controls

60 lines (37 loc) · 1.26 KB

django-statuspage

https://badge.fury.io/py/django-statuspage.png https://travis-ci.org/redfunction/django-statuspage.png?branch=master

Display status and information of the system. Can be used as a heartbeat indicator for load balancer.

Quickstart

Install django-statuspage:

pip install django-statuspage

Then use it in a project:

import djstatuspage

Features

  • Display information about installed system with a simple json response

Usage

Add url in your project with

import djastatuspage

urlpatterns += patterns('',
url(r'^', include(djstatuspage.urls.urlpatterns, namespace='statuspage')),

)

Settings

  • STATUSPAGE_TASKS - define extra callables to add to output in key-value

manner. For example.

STATUSPAGE_TASKS["version"] = lambda: "0.1.0"

Will return

{"database": "ok", "version": "0.1.0"}
  • STATUSPAGE_TRY_DATABASE - Default True. Turn off database round trip.

Cookiecutter Tools Used in Making This Package

  • cookiecutter
  • cookiecutter-djangopackage