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
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
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.
Remember to update History.
- 0.8
- Drop support for python 3.6 and 3.7. Add support for python 3.11. Add experimental support for Django versions 4.0 & 4.1. Improve testing and linting.
- 0.7
- Add support for python 3.9 and 3.10. Improve testing and linting.
- 0.6
- Drop support for python 3.5. Improve linting.
- 0.5
- Drop python 2 support (now compatible with 3.5 - 3.8). Support Django 2.2 - 3.2 (both LTS).
- 0.4
- Include CORS header.
- 0.3
- Add python 2 compatibility.
- 0.2
- Allow including JSON response for healthchecks.
- 0.1
- Original release.
Copyright (C) 2023 HM Government (Ministry of Justice Digital & Technology). See LICENSE.txt for further details.