1 Welcome to Maykin Configuration Checks’ documentation!
- Version:
0.1.0
- Source:
- 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.
2 Installation
2.1 Requirements
Python 3.12 or above
Django 4.2 or newer
2.2 Install
pip install maykin-config-checksAdd 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_fn4 Local development
To develop the library locally, use:
uv pip install -r pyproject.toml --all-extrasTo 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 runserver5 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 tests1 maintainer
Release files for maykin-config-checks 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| maykin_config_checks-0.1.0.tar.gz | 10.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| maykin_config_checks-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.5 kB
Release files / maykin_config_checks-0.1.0.tar.gz
| Download URL | maykin_config_checks-0.1.0.tar.gz |
|---|---|
| Size | 10.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cd15e8e18a43c42b232bdef49f10a7ca3669b292e03dcf031cc689fd3bd6058b
|
|
BLAKE2b-256 checksum How to use checksums |
8c842687952cb9e2bea9fe193236e41ac10d997ce85d25e99844436968852632
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 29, 2025.
Transparency logRelease files / maykin_config_checks-0.1.0-py3-none-any.whl
| Download URL | maykin_config_checks-0.1.0-py3-none-any.whl |
|---|---|
| Size | 8.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d64d86a6bd0d3d1d3a5965376f712402694dfccaf0a95b15ddb011b4d83d7a6b
|
|
BLAKE2b-256 checksum How to use checksums |
51c5956b2f6d302aeeb595cf45d27f2f0711535690a695862636429a7172894a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 29, 2025.
Transparency log
