{ "info": { "author": "Christo Crampton", "author_email": "info@38.co.za", "bugtrack_url": null, "classifiers": [ "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "#\n\n\n\n## Installation\n\n```\npip install dj-healthchecks\n```\n\n## Usage\n\n### Add to a project\n\nIn `urls.py`:\n\n```\nfrom django.conf.urls import url, include\n\nfrom rest_framework import routers\nfrom healthchecks.api import HealthViewSet\n\nrouter = routers.DefaultRouter()\nrouter.register(r'health', HealthViewSet, basename='health')\n\nurlpatterns = [\n path('admin/', admin.site.urls),\n url(r'^', include(router.urls)),\n]\n```\n\n**You define your healthchecks in `settings.py`**\n\n```python\nHEALTH_CHECKS = [\n 'healthchecks.checks.im_ok',\n 'healthchecks.checks.connect_to_db',\n 'healthchecks.checks.connect_to_queue',\n 'healthchecks.checks.connect_to_redis',\n 'healthchecks.checks.ping_upstream_urls',\n ...\n]\n```\n\nThis library provides some utility healthchecks, but you can also easily write your own.\n\nProvided healthchecks are in `healthchecks/checks.py`\n\n**Specifying your own healthcheck:**\n\n```python\nHEALTH_CHECKS = [\n ...\n 'myapp.myodule.my_health_check',\n]\n```\n\n\n**Now you have:**\n\n```\nGET /health/ # run all health checks in settings.py\nGET /health/some-health-check/ # run a specific healthcheck\n```\n\n**Note:** for a specific healthcheck, you `-` will be replaced with `.`\n\n\n## Run project:\n\n```\ndocker-compose up\n```\n\n## Run tests:\n\n```\ndocker-compose run --rm web python manage.py test\n```\n\nProfit.\n\n## Updating\n\nBump the version:\n\n```\nbumpversion manjor|minor|patch\n```\n\nPush to master", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://gitlab.com/schoolorchestration/libs/dj-healthchecks", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "dj-healthchecks", "package_url": "https://pypi.org/project/dj-healthchecks/", "platform": "", "project_url": "https://pypi.org/project/dj-healthchecks/", "project_urls": { "Homepage": "https://gitlab.com/schoolorchestration/libs/dj-healthchecks" }, "release_url": "https://pypi.org/project/dj-healthchecks/0.0.1/", "requires_dist": null, "requires_python": "", "summary": "", "version": "0.0.1" }, "last_serial": 4568319, "releases": { "0.0.0": [ { "comment_text": "", "digests": { "md5": "278b49e84f764b9e0fb6e8180a505448", "sha256": "713cb5ec8fd48fddecd66dadeaf85e845e953df637e847956e16deb60e42ca66" }, "downloads": -1, "filename": "dj-healthchecks-0.0.0.tar.gz", "has_sig": false, "md5_digest": "278b49e84f764b9e0fb6e8180a505448", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1221, "upload_time": "2018-12-06T12:58:17", "url": "https://files.pythonhosted.org/packages/12/7f/890689d8b964f5593ab4e725b9bd3817200190b1583c6ffe273707f55602/dj-healthchecks-0.0.0.tar.gz" } ], "0.0.1": [ { "comment_text": "", "digests": { "md5": "97c1802206cf9c2eccb6fada8f15d89a", "sha256": "b44e8ec2d21ca8007b0fccd814b5a07b4199ab3d314a376d23d45eddda195c61" }, "downloads": -1, "filename": "dj-healthchecks-0.0.1.tar.gz", "has_sig": false, "md5_digest": "97c1802206cf9c2eccb6fada8f15d89a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3001, "upload_time": "2018-12-06T15:33:50", "url": "https://files.pythonhosted.org/packages/01/fd/ee3b46956e9b42e1dbfbb979479597892faf0717befee2d46f4dfe6b5036/dj-healthchecks-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "97c1802206cf9c2eccb6fada8f15d89a", "sha256": "b44e8ec2d21ca8007b0fccd814b5a07b4199ab3d314a376d23d45eddda195c61" }, "downloads": -1, "filename": "dj-healthchecks-0.0.1.tar.gz", "has_sig": false, "md5_digest": "97c1802206cf9c2eccb6fada8f15d89a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3001, "upload_time": "2018-12-06T15:33:50", "url": "https://files.pythonhosted.org/packages/01/fd/ee3b46956e9b42e1dbfbb979479597892faf0717befee2d46f4dfe6b5036/dj-healthchecks-0.0.1.tar.gz" } ] }