Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Library to streamline healthchecks for Directory apps.

Project description

# directory-healthcheck

[![code-climate-image]][code-climate]
[![circle-ci-image]][circle-ci]
[![codecov-image]][codecov]
[![gemnasium-image]][gemnasium]

**Wrapper around [django-health-check](https://github.com/KristianOellegaard/django-health-check) to streamline health checks in [directory apps](https://github.com/uktrade/?utf8=%E2%9C%93&q=directory&type=&language=).**

---

## Usage
In `settings.py` add the following to settings `INSTALLED_APPS`:

`directory_healthcheck`

In `settings.py` state which health check backends should be used, e.g.:

```
DIRECTORY_HEALTHCHECK_BACKENDS = [
directory_healthcheck.backends.db
directory_healthcheck.backends.cache,
directory_healthcheck.backends.elastic_search,
directory_healthcheck.backends.sentry,
]
```

## Installation

```shell
pip install -e git+https://git@github.com/uktrade/directory-healthcheck.git@v0.1.0#egg=directory-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


[code-climate-image]: https://codeclimate.com/github/uktrade/directory-healthcheck/badges/issue_count.svg
[code-climate]: https://codeclimate.com/github/uktrade/directory-healthcheck

[circle-ci-image]: https://circleci.com/gh/uktrade/directory-healthcheck/tree/master.svg?style=svg
[circle-ci]: https://circleci.com/gh/uktrade/directory-healthcheck/tree/master

[codecov-image]: https://codecov.io/gh/uktrade/directory-healthcheck/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/uktrade/directory-healthcheck

[gemnasium-image]: https://gemnasium.com/badges/github.com/uktrade/directory-healthcheck.svg
[gemnasium]: https://gemnasium.com/github.com/uktrade/directory-healthcheck


Project details


Release history Release notifications

This version
History Node

0.4.2

History Node

0.4.1

History Node

0.4.0

History Node

0.3.0

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-0.4.2-py3-none-any.whl (5.5 kB) Copy SHA256 hash SHA256 Wheel py3 Mar 9, 2018

Supported by

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