Metadata-Version: 2.2
Name: django-healthz
Version: 0.0.5
Summary: Simple middleware for healthchecks
Home-page: https://github.com/rehive/django-healthz
Download-URL: https://github.com/rehive/django-healthz/archive/0.0.5.zip
Author: Rehive
Author-email: info@rehive.com
License: MIT
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Requires-Dist: Django>=2.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Rehive Django HealthCheck

## Quick start

1. Install the package:

```
pip install django-healthz
```

2. Add "healthz" to your INSTALLED_APPS settings like this:

```
    INSTALLED_APPS = [
        ...
        'healthz',
    ]
```

3. Include the healtheck middleware in the django middleware:

```
MIDDLEWARE = [
    'healthz.middleware.HealthCheckMiddleware',
    ...
]
```

4. Configure the readiness checks:

```
HEALTHCHECK = {
    'READINESS_CHECKS': ('databases', 'caches', 'queues',)
}
```

## TODO

1. Update responses to JSON
2. Allow customization or readiness and healthz URLs.

