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:
.. code-block:: python
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
-----------
.. image:: https://github.com/ministryofjustice/django-moj-irat/actions/workflows/test.yml/badge.svg?branch=main
:target: https://github.com/ministryofjustice/django-moj-irat/actions/workflows/test.yml
.. image:: https://github.com/ministryofjustice/django-moj-irat/actions/workflows/lint.yml/badge.svg?branch=main
:target: https://github.com/ministryofjustice/django-moj-irat/actions/workflows/lint.yml
Please report bugs and open pull requests on `GitHub`_.
To work on changes to this library, it’s recommended to install it in editable mode into a virtual environment,
i.e. ``pip install --editable .``
Use ``python -m tests`` to run all tests locally.
Alternatively, you can use ``tox`` if you have multiple python versions.
[Only for GitHub team members] Distribute a new version to `PyPI`_ by:
- updating the ``VERSION`` tuple in ``moj_irat/__init__.py``
- adding a note to the `History`_
- publishing a release on GitHub which triggers an upload to PyPI;
alternatively, run ``python -m build; twine upload dist/*`` locally
History
-------
0.9
Migrated test, build and release processes away from deprecated setuptools commands.
No significant library changes.
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
---------
Copyright (C) 2023 HM Government (Ministry of Justice Digital & Technology).
See LICENSE.txt for further details.
.. _GitHub: https://github.com/ministryofjustice/django-moj-irat
.. _PyPI: https://pypi.org/project/django-moj-irat/
Raw data
{
"_id": null,
"home_page": "https://github.com/ministryofjustice/django-moj-irat",
"name": "django-moj-irat",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "django,irat,moj,monitoring",
"author": "Ministry of Justice Digital & Technology",
"author_email": "dev@digital.justice.gov.uk",
"download_url": "https://files.pythonhosted.org/packages/1c/44/84c290b12f3820e89b499d29c472c01477f826e222909dfe0a9904e53f83/django-moj-irat-0.9.tar.gz",
"platform": null,
"description": "IRaT support for Django\n=======================\n\nA set of tools to make it easier to add a Django-based service to Ministry of Justice's Incidence Response and Tuning:\n\n* ping.json view\n* healthcheck.json view with extensible healthchecks\n\nUsage\n-----\n\nInstall using ``pip install django-moj-irat``.\n\nDjango settings:\n\n.. code-block:: python\n\n HEALTHCHECKS = [\n 'moj_irat.healthchecks.database_healthcheck',\n # override default list of healthcheck callables\n ]\n AUTODISCOVER_HEALTHCHECKS = True # whether to autodiscover and load healthcheck.py from all installed apps\n\nDevelopment\n-----------\n\n.. image:: https://github.com/ministryofjustice/django-moj-irat/actions/workflows/test.yml/badge.svg?branch=main\n :target: https://github.com/ministryofjustice/django-moj-irat/actions/workflows/test.yml\n\n.. image:: https://github.com/ministryofjustice/django-moj-irat/actions/workflows/lint.yml/badge.svg?branch=main\n :target: https://github.com/ministryofjustice/django-moj-irat/actions/workflows/lint.yml\n\nPlease report bugs and open pull requests on `GitHub`_.\n\nTo work on changes to this library, it\u2019s recommended to install it in editable mode into a virtual environment,\ni.e. ``pip install --editable .``\n\nUse ``python -m tests`` to run all tests locally.\nAlternatively, you can use ``tox`` if you have multiple python versions.\n\n[Only for GitHub team members] Distribute a new version to `PyPI`_ by:\n\n- updating the ``VERSION`` tuple in ``moj_irat/__init__.py``\n- adding a note to the `History`_\n- publishing a release on GitHub which triggers an upload to PyPI;\n alternatively, run ``python -m build; twine upload dist/*`` locally\n\nHistory\n-------\n\n0.9\n Migrated test, build and release processes away from deprecated setuptools commands.\n No significant library changes.\n\n0.8\n Drop support for python 3.6 and 3.7.\n Add support for python 3.11.\n Add experimental support for Django versions 4.0 & 4.1.\n Improve testing and linting.\n\n0.7\n Add support for python 3.9 and 3.10.\n Improve testing and linting.\n\n0.6\n Drop support for python 3.5.\n Improve linting.\n\n0.5\n Drop python 2 support (now compatible with 3.5 - 3.8).\n Support Django 2.2 - 3.2 (both LTS).\n\n0.4\n Include CORS header.\n\n0.3\n Add python 2 compatibility.\n\n0.2\n Allow including JSON response for healthchecks.\n\n0.1\n Original release.\n\nCopyright\n---------\n\nCopyright (C) 2023 HM Government (Ministry of Justice Digital & Technology).\nSee LICENSE.txt for further details.\n\n.. _GitHub: https://github.com/ministryofjustice/django-moj-irat\n.. _PyPI: https://pypi.org/project/django-moj-irat/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tools to support adding a Django-based service to Ministry of Justice\u2019s Incidence Response and Tuning",
"version": "0.9",
"project_urls": {
"Homepage": "https://github.com/ministryofjustice/django-moj-irat"
},
"split_keywords": [
"django",
"irat",
"moj",
"monitoring"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc06685773a9cc4a9371d4919fc1321cd60e249769219c278e01c10569807d28",
"md5": "cdd0ec95770eb9ecde70ffc72ba2b7a9",
"sha256": "625e29b411ac4b6f539d8595f126e7b05538ef1d0cc643d58cb465700f6a5a75"
},
"downloads": -1,
"filename": "django_moj_irat-0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cdd0ec95770eb9ecde70ffc72ba2b7a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6854,
"upload_time": "2023-11-16T15:32:31",
"upload_time_iso_8601": "2023-11-16T15:32:31.966749Z",
"url": "https://files.pythonhosted.org/packages/dc/06/685773a9cc4a9371d4919fc1321cd60e249769219c278e01c10569807d28/django_moj_irat-0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c4484c290b12f3820e89b499d29c472c01477f826e222909dfe0a9904e53f83",
"md5": "32b586fe3de5bb4acbb2a05280389081",
"sha256": "6339a973b321e99777a4fea206e973d1c8bf651195236094be50584ead803b41"
},
"downloads": -1,
"filename": "django-moj-irat-0.9.tar.gz",
"has_sig": false,
"md5_digest": "32b586fe3de5bb4acbb2a05280389081",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8442,
"upload_time": "2023-11-16T15:32:33",
"upload_time_iso_8601": "2023-11-16T15:32:33.948152Z",
"url": "https://files.pythonhosted.org/packages/1c/44/84c290b12f3820e89b499d29c472c01477f826e222909dfe0a9904e53f83/django-moj-irat-0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-16 15:32:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ministryofjustice",
"github_project": "django-moj-irat",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-moj-irat"
}
JSON
