Metadata-Version: 2.1
Name: drf_health_check
Version: 0.0.12
Summary: Various health check view for the Django Framework
Home-page: https://github.com/ihor-voronin/health-checker-django
Author: Ihor Voronin
Author-email: VoroninIhor@gmail.com
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: drf-spectacular>=0.17.2
Requires-Dist: django>=3.2
Requires-Dist: djangorestframework>=3.10.0

# drf_health_check
Various health check extensions for the Django Rest Framework

[![PyPI Version][pypi-image]][pypi-url]

[pypi-image]: https://img.shields.io/pypi/v/drf_health_check
[pypi-url]: https://pypi.org/project/drf_health_check/

# Installation

Using pip

`pip install drf_health_check`

Using pipenv

`pipenv install drf_health_check`

# Quick start
In your project’s `settings.py` add `HEALTH_CHECK_PROVIDERS`.

``` 
HEALTH_CHECK_PROVIDERS = {
    ...
    'drf_health_check.providers.DBHealthCheckProvider',
    ...
}
```

Add `drf_health_check` to `INSTALLED_APPS` 
```
INSTALLED_APPS = [
    ...
    "drf_health_check",
]
```

Add urls to you project for health-view
```
urlpatterns = [
    ...
    url("health/", include('django_health_check_view.urls')),
    ...
]
```
