Metadata-Version: 2.1
Name: django-simple-health-check
Version: 0.1.0
Summary: Simple Django health check
Home-page: https://github.com/pikhovkin/django-simple-health-check
Author: Sergei Pikhovkin
Author-email: s@pikhovkin.ru
License: MIT
Description: # django-simple-health-check
        
        [![GitHub Actions](https://github.com/pikhovkin/django-simple-health-check/workflows/build/badge.svg)](https://github.com/pikhovkin/django-simple-health-check/actions)
        [![PyPI](https://img.shields.io/pypi/v/django-simple-health-check.svg)](https://pypi.org/project/django-simple-health-check/)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-simple-health-check.svg)
        [![framework - Django](https://img.shields.io/badge/framework-Django-0C3C26.svg)](https://www.djangoproject.com/)
        ![PyPI - Django Version](https://img.shields.io/pypi/djversions/django-simple-health-check.svg)
        [![PyPI - License](https://img.shields.io/pypi/l/django-simple-health-check)](./LICENSE)
        
        Simple Django health check
        
        Inspired by:
        - [django-alive](https://github.com/lincolnloop/django-alive)
        - [django-healthchecks](https://github.com/mvantellingen/django-healthchecks)
        - [django-health-check](https://github.com/KristianOellegaard/django-health-check)
        - [django-healthz](https://github.com/rehive/django-healthz)
        - [django-watchman](https://github.com/mwarkentin/django-watchman)
        
        ### Installation
        
        ```bash
        $ pip install django-simple-health-check
        ```
        
        ### Quick start
        
        1. Install the package
        
        2. Add `simple_health_check` to your INSTALLED_APPS settings like this:
        
        ```python
        INSTALLED_APPS = [
            ...,
            'simple_health_check',
        ]
        ```
        
        3. Add `simple_health_check.urls` to main `urls.py`:
        
        ```python
        from django.urls import path, include
        
        urlpatterns = [
            ...,
            path('', include('simple_health_check.urls')),
        ]
        ```
        
        4. Configure the readiness checks:
        
        ```python
        SIMPLE_HEALTH_CHECKS = {
            'simple_health_check.checks.migrations.Migrations': [
                dict(alias='db1'),
                dict(alias='db2'),
            ],
            'simple_health_check.checks.db.Databases': None,
        }
        ```
        
        by default
        
        ```python
        SIMPLE_HEALTH_CHECKS = {
            'simple_health_check.checks.migrations.Migrations': None,  # check all aliases
            'simple_health_check.checks.db.Databases': None,  # check all aliases
        }
        ```
        
        ## License
        
        MIT
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7.*, <4.0.*
Description-Content-Type: text/markdown
