Skip to main content

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

Metadata

Release files for directory-healthcheck 4.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for directory-healthcheck 4.3
File Interpreter ABI Platform
directory_healthcheck-4.3-py3-none-any.whl Python 3 none any Details

Release files / directory_healthcheck-4.3-py3-none-any.whl

Download URL directory_healthcheck-4.3-py3-none-any.whl
Size 6.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
831677eeabdf968cc9d9849606aadb62999369b1f4334eb7dd3d8519f4943bfd
BLAKE2b-256 checksum
How to use checksums
95547d7090c72996b9f619522e10dc088405f38bffaf916235f182703aae1f13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

4.3 This release

1 release file

4.2

1 release file

4.1

1 release file

4.0

1 release file

3.8

1 release file

3.7

1 release file

3.6

1 release file

3.5

1 release file

3.4

1 release file

3.3

1 release file

3.2

1 release file

3.1.2

1 release file

3.1.1

1 release file

3.1.0

1 release file

3.0.4

1 release file

3.0.3

1 release file

3.0.2

1 release file

3.0.1

1 release file

3.0.0

1 release file

2.0.0

1 release file

1.1.2

1 release file

1.1.1

1 release file

1.0.1

1 release file

1.0.0

1 release file

0.6.0

1 release file

0.5.1

1 release file

0.5.0

1 release file

0.4.3

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page