maykin-config-checks 0.1.0

Library to help with defining and running health checks for Maykin Django projects.

1 Welcome to Maykin Configuration Checks’ documentation!

Version:

0.1.0

Source:

https://github.com/maykinmedia/config-checks

Keywords:

Django, Maykin, health checks

PythonVersion:

3.12, 3.13

This library aims to standardise how health checks for Maykin Django applications are run. The checks are meant to validate that the configuration that is normally performed in the Admin or via django-setup-configuration is correct.

Contents

• 1 Welcome to Maykin Configuration Checks’ documentation!

• 2 Installation

  • 2.1 Requirements

  • 2.2 Install

• 3 Usage

  • 3.1 View

  • 3.2 Management command

• 4 Local development

• 5 Running tests

2 Installation

2.1 Requirements

• Python 3.12 or above

• Django 4.2 or newer

2.2 Install

pip install maykin-config-checks

Add maykin_config_checks to the Django INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    "maykin_config_checks",
    ...
]

3 Usage

3.1 View

To have an API view that returns the results of the performed health checks, add the following to the urlpatterns:

from django.urls import path

from maykin_config_checks.api.views import HealthChecksView

urlpatterns = [
    ...
    path(
        "health-checks",
        HealthChecksView.as_view(
            checks_collector=my_checks_collector_fn
        ),
        name="health-checks",
    ),
]

Where my_checks_collector_fn is a Callable[[], Iterable[HealthCheck]]. It is used to retrieve which health checks should be performed by the view. You can also add the view multiple times to the urlpatters with different checks_collector arguments if you want to have multiple health check views that run different checks.

3.2 Management command

There is also a management command that can be used to run health checks from the CLI.

django-admin config_checks --checks-collector dotted.path.to.my_checks_collector_fn

4 Local development

To develop the library locally, use:

uv pip install -r pyproject.toml --all-extras

To run the test app, in the root of the repository run:

export DJANGO_SETTINGS_MODULE=testapp.settings
export PYTHONPATH=$PYTHONPATH:`pwd`

Then, you can run:

django-admin runserver

5 Running tests

To run the tests without tox, you can do the following (from the root of the repository):

export DJANGO_SETTINGS_MODULE=testapp.settings
export PYTHONPATH=$PYTHONPATH:`pwd`
pytest tests