This is the auto-generated reference for django-watchman's Python API. For a higher-level overview see the Getting Started guide and the Configuration page.
The Django views that power watchman's HTTP endpoints.
::: watchman.views options: show_source: false members: - status - bare_status - ping - dashboard - run_checks
Built-in health-check functions for Django backing services. Each function
can be referenced by its dotted path in
[WATCHMAN_CHECKS][watchman.settings.WATCHMAN_CHECKS].
::: watchman.checks options: members: - caches - databases - email - storage
All settings are read from your Django settings module with sensible
defaults. See the Configuration guide for usage
details.
::: watchman.settings
Include these in your root URL configuration with
url(r'^watchman/', include('watchman.urls')).
| URL pattern | View | Name |
|---|---|---|
/ |
[status][watchman.views.status] |
status |
/dashboard/ |
[dashboard][watchman.views.dashboard] |
dashboard |
/ping/ |
[ping][watchman.views.ping] |
ping |
::: watchman.constants
::: watchman.decorators options: show_source: false members: - check - parse_auth_header - token_required - auth
::: watchman.utils