Metadata-Version: 1.1
Name: django-canary-endpoint
Version: 0.2.0
Summary: Resource health checks for Django.
Home-page: https://github.com/TabbedOut/django-canary-endpoint
Author: TabbedOut
Author-email: dev@tabbedout.com
License: MIT License
Description: 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
        
        
        ### Quickstart
        
        ```python
        # 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/$', status, {'canary': canary}))
        ```
        
        See the [example project](./tests/projects/example.py) for full configuration.
        
        Also see the [example response data](./tests/fixtures/ok.json).
        
        
        ### Testing
        
            make test
            open coverage/index.html
        
        For more thorough multi-Django version testing, (`arc lint` will not run this)
        use:
        
            tox
        
        
        ### License
        
        The MIT License (MIT)
        
        Copyright 2015 ATX Innovations
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: MIT License
