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
[![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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for directory_healthcheck-0.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | abd62590087b71a81db1b7fd819baea85b4000c17d701d3be245610c506f324e |
|
MD5 | 2343e4c18a9313da9e75d2d8f7087afe |
|
BLAKE2b-256 | 0b6c288d4d1874c586a074754b11e952ef15aae3970235b5d39873007a3bf793 |