{ "info": { "author": "Django Server Guardian API", "author_email": "daniel.kaufhold@bitmazk.com", "bugtrack_url": null, "classifiers": [], "description": "Django Server Guardian API\n==========================\n\nAPI offering health metrics for the `Django Server Guardian`_ app.\n\nInstallation and Usage\n----------------------\n\nTo get the latest stable release from PyPi\n\n.. code-block:: bash\n\n pip install django-server-guardian-api\n\nTo get the latest commit from GitHub\n\n.. code-block:: bash\n\n pip install -e git+git://github.com/bitmazk/django-server-guardian-api.git#egg=server_guardian_api\n\nAdd ``server_guardian_api`` to your ``INSTALLED_APPS``\n\n.. code-block:: python\n\n INSTALLED_APPS = (\n ...,\n 'server_guardian_api',\n )\n\nAdd the ``server_guardian_api`` URLs to your ``urls.py``\n\n.. code-block:: python\n\n urlpatterns = [\n url(r'^server-guardian-api/', include('server_guardian_api.urls')),\n ]\n\nAs a simple auth method add the security token as described in the README of\nthe `Django Server Guardian`_ to your settings as ``SERVER_GUARDIAN_SECURITY_TOKEN``\n\n.. code-block:: python\n\n SERVER_GUARDIAN_SECURITY_TOKEN = 'asd0hb42t92-example-token-39gh1g3-91hfosj325'\n\n\nAdd the ``SERVER_GUARDIAN_PROCESSORS`` setting where you're endpoint metrics\nare defined.\n\n.. code-block:: python\n\n SERVER_GUARDIAN_PROCESSORS = (\n 'server_guardian_api.endpoints.mailer_mail',\n 'myapp.mymodule.myfunction',\n )\n\nThe functions defined in this setting must return a dictionary in the following\nformat\n\n.. code-block:: python\n\n {\n 'status': 'OK', # must be one of: \"OK\", \"WARNING\", \"DANGER\"\n 'info': 'additional text describing the status. e.g. type of error',\n }\n\nThat mean, your API endpoint will, if all is correct, return something like this\n\n.. code-block:: python\n\n [\n {\n 'label': 'mail_queue',\n 'status': 'OK',\n 'info': \"No deferred email queued. That's great!\",\n },\n {\n 'label': 'other_metric',\n ...\n },\n ]\n\n\n\nContribute\n----------\n\nIf you want to contribute to this project, please perform the following steps\n\n.. code-block:: bash\n\n # Fork this repository\n # Clone your fork\n mkvirtualenv -p python2.7 django-server-guardian-api\n make develop\n\n git co -b feature_branch master\n # Implement your feature and tests\n git add . && git commit\n git push -u origin feature_branch\n # Send us a pull request for your feature branch\n\nIn order to run the tests, simply execute ``tox``. This will install two new\nenvironments (for Django 1.8 and Django 1.9) and run the tests against both\nenvironments.\n\n.. _Django Server Guardian: https://github.com/bitmazk/django-server-guardian", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bitmazk/django-server-guardian-api", "keywords": "django,app,reusable,server,guardian,api,health,status", "license": "The MIT License", "maintainer": null, "maintainer_email": null, "name": "django-server-guardian-api", "package_url": "https://pypi.org/project/django-server-guardian-api/", "platform": "OS Independent", "project_url": "https://pypi.org/project/django-server-guardian-api/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/bitmazk/django-server-guardian-api" }, "release_url": "https://pypi.org/project/django-server-guardian-api/0.1.2/", "requires_dist": null, "requires_python": null, "summary": "API offering health metrics for the ``django-server-guardian`` app.", "version": "0.1.2" }, "last_serial": 2095834, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "671b09077531d7692f9f3634c9b8d5dd", "sha256": "f8a9968c62e834bc98cfa00a8cdd0888d31cefd7801391c5c882a8459a9ed060" }, "downloads": -1, "filename": "django-server-guardian-api-0.1.tar.gz", "has_sig": false, "md5_digest": "671b09077531d7692f9f3634c9b8d5dd", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8482, "upload_time": "2015-12-09T06:48:40", "url": "https://files.pythonhosted.org/packages/32/bd/3d8805c478b8090ebbbcd084f53d71475c3fa14c206b625660976546f98c/django-server-guardian-api-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "f962bb17faa0a3cc15513ead3658b6ed", "sha256": "a1178fa5e017ad661827caa17dd28fc8ecabd20428d127f52364499b9e6cc22a" }, "downloads": -1, "filename": "django-server-guardian-api-0.1.1.tar.gz", "has_sig": false, "md5_digest": "f962bb17faa0a3cc15513ead3658b6ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8997, "upload_time": "2015-12-09T10:14:12", "url": "https://files.pythonhosted.org/packages/42/e1/6555dced15b4d2f910d5897d47878addc3087f7b12c8114d8bba7b2bb12a/django-server-guardian-api-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "c1e39a70ac1dce441614a0a27887e193", "sha256": "e73ed3d3175d74ea9762d007695a83759c88ba21fcf4d4f354fbff607513fce4" }, "downloads": -1, "filename": "django-server-guardian-api-0.1.2.tar.gz", "has_sig": false, "md5_digest": "c1e39a70ac1dce441614a0a27887e193", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7842, "upload_time": "2016-05-02T21:49:32", "url": "https://files.pythonhosted.org/packages/c3/6f/b76b02ca7955677edae38c54269a2dfb4a976b2b3caa345eca75708e8ea2/django-server-guardian-api-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c1e39a70ac1dce441614a0a27887e193", "sha256": "e73ed3d3175d74ea9762d007695a83759c88ba21fcf4d4f354fbff607513fce4" }, "downloads": -1, "filename": "django-server-guardian-api-0.1.2.tar.gz", "has_sig": false, "md5_digest": "c1e39a70ac1dce441614a0a27887e193", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7842, "upload_time": "2016-05-02T21:49:32", "url": "https://files.pythonhosted.org/packages/c3/6f/b76b02ca7955677edae38c54269a2dfb4a976b2b3caa345eca75708e8ea2/django-server-guardian-api-0.1.2.tar.gz" } ] }