Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.4 KB

README.rst

File metadata and controls

45 lines (30 loc) · 1.4 KB

IRaT support for Django

A set of tools to make it easier to add a Django-based service to Ministry of Justice's Incidence Response and Tuning:

  • ping.json view
  • healthcheck.json view with extensible healthchecks

Usage

Install using pip install django-moj-irat.

Django settings:

HEALTHCHECKS = [
    'moj_irat.healthchecks.database_healthcheck',
    # override default list of healthcheck callables
]
AUTODISCOVER_HEALTHCHECKS = True  # whether to autodiscover and load healthcheck.py from all installed apps

Development

https://github.com/ministryofjustice/django-moj-irat/workflows/Run%20tests/badge.svg?branch=main

Please report bugs and open pull requests on GitHub.

Use python setup.py test to run all tests.

Distribute a new version to PyPi by updating the VERSION tuple in moj_irat/__init__.py and publishing a release in GitHub (this triggers a GitHub Actions workflow to automatically upload it). Alternatively, run python setup.py sdist bdist_wheel upload locally.

Copyright

Copyright (C) 2022 HM Government (Ministry of Justice Digital & Technology). See LICENSE.txt for further details.