{ "info": { "author": "TabbedOut", "author_email": "dev@tabbedout.com", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5" ], "description": "[![Build Status](https://travis-ci.org/TabbedOut/django_canary_endpoint.svg?branch=master)](https://travis-ci.org/TabbedOut/django_canary_endpoint)\n\nDjango Canary Endpoint\n======================\n\nProvides [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)\nfor common Django dependencies.\n\n\n### Installation\n\n pip install django-canary-endpoint\n\nIf you use RQ you also need to install the `rq` extra:\n\n pip install django-canary-endpoint[rq]\n\n\n### Quickstart\n\n```\n# Canary\n########\n\nfrom canary_endpoint import GitCanary\nfrom canary_endpoint.resources.databases import DjangoDatabase\nfrom canary_endpoint.resources.rq import DjangoRQ\nfrom canary_endpoint.resources.services import Service, ServiceWithCanary\n\ncanary = GitCanary('example', root=ROOT, version=VERSION, resources=[\n DjangoDatabase(statements=['SELECT 1 FROM foo LIMIT 1']),\n DjangoRQ(),\n Service('foo', url=HTTP_ENDPOINT),\n ServiceWithCanary('bar', url=HTTP_ENDPOINT_WITH_CANARY),\n])\n\n\n# URLs\n######\n\nfrom canary_endpoint.views import status\nfrom django.conf.urls import patterns, url\n\nurlpatterns = patterns('', url(r'^_status/$', status, {'canary': canary}))\n```\n\nSee the [example project](./tests/projects/example.py) for full configuration.\n\nAlso see the [example response data](./tests/fixtures/ok.json).\n\n\n### Testing\n\nThere are several ways to run the projects tests. The recommended approach\nis to run `tox`, becuase your testing environment will be properly set-up.\n\nFor a thorough multi-Django version testing use:\n\n $ tox\n\nTo list the configured environments:\n\n $ tox -l\n py27-django15\n py27-django16\n py27-django17\n py27-django18\n py27-djangorq\n py35-django18\n\nYou can execute a single test environment:\n\n $ tox -e py35-django18\n\nIf you manage your own environment, you can run the `make test` command\nyourself. It is recommened that you do this in a _virtualenv_.\n\n $ pip install -r requirements.txt # Normally tox would install these\n $ pip install \"django<1.9\" django-rq # Normally tox would install these\n $ make test\n $ open coverage/index.html\n\nYou can run a subset of tests by setting the `PACKAGES` variable:\n\n $ make PACKAGES=\"tests.test_endpoint tests.test_service_resources\"\n\nTo run a single test:\n\n $ make PACKAGES=tests.test_endpoint:EndpointTestCase.test_status_endpoint_returns_200_on_success\n\n\n### License\n\nThe MIT License (MIT)\n\nCopyright 2016 ATX Innovations", "description_content_type": null, "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/TabbedOut/django_canary_endpoint", "keywords": null, "license": "MIT License", "maintainer": null, "maintainer_email": null, "name": "django-canary-endpoint", "package_url": "https://pypi.org/project/django-canary-endpoint/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-canary-endpoint/", "project_urls": { "Homepage": "https://github.com/TabbedOut/django_canary_endpoint" }, "release_url": "https://pypi.org/project/django-canary-endpoint/0.7.1/", "requires_dist": null, "requires_python": null, "summary": "Resource health checks for Django.", "version": "0.7.1" }, "last_serial": 2694997, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "7ce17cf3d8beefddc4b4041edf12b386", "sha256": "30ad4c03fae58a02b4f15d2d354f4cd7bccde651c8725d451908aa19b287ef31" }, "downloads": -1, "filename": "django_canary_endpoint-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "7ce17cf3d8beefddc4b4041edf12b386", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 12913, "upload_time": "2015-03-02T21:47:50", "url": "https://files.pythonhosted.org/packages/b2/b3/844e5c4edc506b6c415c81afe7acc94316ee32c3eaf20a698db18ca679a7/django_canary_endpoint-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1482611ce126830bd228a83ecd086199", "sha256": "0e5393bdb47bbf0377de96d4b389b7689bcf63d0f469c4680e4d8292155b1333" }, "downloads": -1, "filename": "django-canary-endpoint-0.1.2.tar.gz", "has_sig": false, "md5_digest": "1482611ce126830bd228a83ecd086199", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6919, "upload_time": "2015-03-02T21:47:47", "url": "https://files.pythonhosted.org/packages/ff/f1/9287f57596309298795fad504fca38278fffffca2ea7e1a74d93fa88647e/django-canary-endpoint-0.1.2.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "80d912e7b82149b67afe9cb355659dc8", "sha256": "f33639eadf3e4577aa75864f0bafceed4d437d4c8474346326c13de8a5b6f2f6" }, "downloads": -1, "filename": "django-canary-endpoint-0.2.0.tar.gz", "has_sig": false, "md5_digest": "80d912e7b82149b67afe9cb355659dc8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8020, "upload_time": "2015-04-14T21:28:40", "url": "https://files.pythonhosted.org/packages/68/6b/8d751ead5915227495d0776385133f7d470e28ba6186bf82dbec2518c5dd/django-canary-endpoint-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "fbc72f2922aaf4a72554aead3ff969be", "sha256": "6a3667e707e4f27fa0f2a93be8a689596bd711635216919092d00abfcbbbd989" }, "downloads": -1, "filename": "django_canary_endpoint-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "fbc72f2922aaf4a72554aead3ff969be", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 14472, "upload_time": "2015-06-01T18:18:23", "url": "https://files.pythonhosted.org/packages/40/c5/9f82dad80ffa9c3bb215d5c87ea63637355152aa459b885d077f2a7ca6c2/django_canary_endpoint-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "13515b39a4f401db3bdd02ff432f720a", "sha256": "652abe839249be4418fc1c70407d9710bab41b175d09c2ed45e4eaceab33fea5" }, "downloads": -1, "filename": "django-canary-endpoint-0.3.0.tar.gz", "has_sig": false, "md5_digest": "13515b39a4f401db3bdd02ff432f720a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8806, "upload_time": "2015-06-01T18:18:20", "url": "https://files.pythonhosted.org/packages/e4/b4/6704325d705bdc8049a9e56468bd9917d1680d0b08d62a60fc617d19f4c1/django-canary-endpoint-0.3.0.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "cd417b4ede3ec0f192d1c3629e306c41", "sha256": "36913644e628dd49e376b5e339595e4deb545bfe8fc12f5f1bbf30d3c3ebcfeb" }, "downloads": -1, "filename": "django-canary-endpoint-0.4.0.tar.gz", "has_sig": false, "md5_digest": "cd417b4ede3ec0f192d1c3629e306c41", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8954, "upload_time": "2015-11-23T21:39:13", "url": "https://files.pythonhosted.org/packages/81/60/ceb07dcfae9425c979bc22d9b5c6302068cc5026f980ae61968b1791fd64/django-canary-endpoint-0.4.0.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "ab737c8fe8d94c651bdba4ba9a2307bd", "sha256": "9a33e3458876a2546024d55c518868e926985fd612c418a05b2450b39e8c8796" }, "downloads": -1, "filename": "django-canary-endpoint-0.5.0.tar.gz", "has_sig": false, "md5_digest": "ab737c8fe8d94c651bdba4ba9a2307bd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8147, "upload_time": "2016-01-25T19:59:35", "url": "https://files.pythonhosted.org/packages/ee/50/4091d2aa5263c30158c13943a29488f7b3686acf2947a4ffe6546c87c85d/django-canary-endpoint-0.5.0.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "47107703be2b1094ee7910e73273128a", "sha256": "ae650397fbc5f5b9d2806b638f49570580a5644c7d3a7a195a29c7532a1beeba" }, "downloads": -1, "filename": "django-canary-endpoint-0.6.0.tar.gz", "has_sig": false, "md5_digest": "47107703be2b1094ee7910e73273128a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8220, "upload_time": "2016-04-07T19:28:30", "url": "https://files.pythonhosted.org/packages/a9/9f/6d7d2c63c21e4fa4437437027252a9bd5d622df5e7de4d5aeab9ac8e01ec/django-canary-endpoint-0.6.0.tar.gz" } ], "0.7.0": [ { "comment_text": "", "digests": { "md5": "9b0ae54f629105e9d93b27249fb34f96", "sha256": "b32eff98ff854490f1fb893e6133e4aae6b552a1984f6df3086f7fcef7fecd0a" }, "downloads": -1, "filename": "django-canary-endpoint-0.7.0.tar.gz", "has_sig": false, "md5_digest": "9b0ae54f629105e9d93b27249fb34f96", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8713, "upload_time": "2017-03-08T22:40:14", "url": "https://files.pythonhosted.org/packages/92/bf/c6b87ad5bbb6f69ad673e935ffa1feed6ae552a8bd9276a42f0c04d5dace/django-canary-endpoint-0.7.0.tar.gz" } ], "0.7.1": [ { "comment_text": "", "digests": { "md5": "3ecabfe970859f900c20decc3fae2405", "sha256": "492f730cf816f5847413ec408b5eae39ac3b34b520f589bc2ecc025a24366b87" }, "downloads": -1, "filename": "django-canary-endpoint-0.7.1.tar.gz", "has_sig": false, "md5_digest": "3ecabfe970859f900c20decc3fae2405", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8782, "upload_time": "2017-03-09T19:48:51", "url": "https://files.pythonhosted.org/packages/82/11/8a1fe8f0cf00330ac7c9ab64318729634ba418e89bd990e5eb39f0154d98/django-canary-endpoint-0.7.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3ecabfe970859f900c20decc3fae2405", "sha256": "492f730cf816f5847413ec408b5eae39ac3b34b520f589bc2ecc025a24366b87" }, "downloads": -1, "filename": "django-canary-endpoint-0.7.1.tar.gz", "has_sig": false, "md5_digest": "3ecabfe970859f900c20decc3fae2405", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8782, "upload_time": "2017-03-09T19:48:51", "url": "https://files.pythonhosted.org/packages/82/11/8a1fe8f0cf00330ac7c9ab64318729634ba418e89bd990e5eb39f0154d98/django-canary-endpoint-0.7.1.tar.gz" } ] }