django-canary-endpoint 0.7.1

[](https://travis-ci.org/TabbedOut/django_canary_endpoint)

Django Canary Endpoint
======================

Provides [canary endpoints](http://byterot.blogspot.com/2014/11/health-endpoint-in-api-design-slippery-rest-api-design-canary-endpoint-hysterix-asp-net-web-api.html)
for common Django dependencies.


### Installation

pip install django-canary-endpoint

If you use RQ you also need to install the `rq` extra:

pip install django-canary-endpoint[rq]


### Quickstart

```
# Canary
########

from canary_endpoint import GitCanary
from canary_endpoint.resources.databases import DjangoDatabase
from canary_endpoint.resources.rq import DjangoRQ
from canary_endpoint.resources.services import Service, ServiceWithCanary

canary = GitCanary('example', root=ROOT, version=VERSION, resources=[
DjangoDatabase(statements=['SELECT 1 FROM foo LIMIT 1']),
DjangoRQ(),
Service('foo', url=HTTP_ENDPOINT),
ServiceWithCanary('bar', url=HTTP_ENDPOINT_WITH_CANARY),
])


# URLs
######

from canary_endpoint.views import status
from django.conf.urls import patterns, url

urlpatterns = patterns('', url(r'^_status/$\text{You can't use 'macro parameter character \#' in math mode}$ tox

To list the configured environments:

$tox-lpy27-django15py27-django16py27-django17py27-django18py27-djangorqpy35-django18Youcanexecuteasingletestenvironment:$ tox -e py35-django18

If you manage your own environment, you can run the `make test` command
yourself. It is recommened that you do this in a _virtualenv_.

$\text{You can't use 'macro parameter character \#' in math mode}$ pip install "django<1.9" django-rq # Normally tox would install these
$maketest$ open coverage/index.html

You can run a subset of tests by setting the `PACKAGES` variable:

$makePACKAGES="tests.tes{t}_{e}ndpointtests.tes{t}_{s}ervic{e}_{r}esources"Torunasingletest:$ make PACKAGES=tests.test_endpoint:EndpointTestCase.test_status_endpoint_returns_200_on_success


### License

The MIT License (MIT)

Copyright 2016 ATX Innovations