Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Library to streamline healthchecks for Directory apps.

Project description

directory-healthcheck

code-climate-image circle-ci-image codecov-image pypi-image

Wrapper around django-health-check to streamline health checks in directory apps.


Installation

pip install directory-healthcheck

Usage

Update your settings.py:

import directory_healthcheck.backends


INSTALLED_APPS = [
    ...
    'directory_healthcheck',
    ...
]

DIRECTORY_HEALTHCHECK_TOKEN = 'some-secret-token'

DIRECTORY_HEALTHCHECK_BACKENDS [
    directory_healthcheck.backends.APIBackend,
    directory_healthcheck.backends.SingleSignOnBackend,
    directory_healthcheck.backends.FormsAPIBackend,
]

Update your urls.py:

    url(
        r'^healthcheck/$',
        directory_healthcheck.views.HealthcheckView.as_view(),
        name='healthcheck'
    ),

Development

$ git clone https://github.com/uktrade/directory-healthcheck
$ cd directory-healthcheck
$ make

Publish to PyPI

The package should be published to PyPI on merge to master. If you need to do it locally then get the credentials from rattic and add the environment variables to your host machine:

Setting
DIRECTORY_PYPI_USERNAME
DIRECTORY_PYPI_PASSWORD

Then run the following command:

make publish

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
directory_healthcheck-1.0.1-py3-none-any.whl (5.7 kB) Copy SHA256 hash SHA256 Wheel py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page