Metadata-Version: 1.0
Name: django-canary-endpoint
Version: 0.1.2
Summary: Resource health checks for Django.
Home-page: https://github.com/TabbedOut/django-canary-endpoint
Author: TabbedOut
Author-email: dev@tabbedout.com
License: The MIT License (MIT)

Copyright (c) 2015 ATX Innovations

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

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.defaults import patterns
        
        urlpatterns = patterns('', (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
        
        
        ### License
        
        The MIT License (MIT)
        
        Copyright 2015 ATX Innovations
        
Platform: UNKNOWN
