{
    "info": {
        "author": "Cameron Rosier",
        "author_email": "cameron_rosier@otpp.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3"
        ],
        "description": "# Installation\n\n```bash\npip3.7 install --user FlaskHealthCheck #use whatever pip version you have, but this is built for python3+\n```\n\n# Requirements\nThis package relies on a couple of things:\n\n1. Your Flask application has a file called 'appversion.txt' in its root directory with a line at the top that looks like:  \n   version: x.x.x  (check the flask-template for clarification)\n\n2. You've got Python 3+ installed as well as Flask and all of your necessary dependencies (obviously, including the package we install here)\n\n# Use\nWithin your routes file that will contain the health check endpoint do the following:\n\n```python\nimport FlaskHealthCheck\n\n#Add your endpoint like so:\n@app.route('/api/healthcheck')\n@cross_origin()\n@swag_from('../swags/healthcheck/healthcheck.yml') #or wherever your swagger file may be for this endpoint\ndef health_check():\n    return jsonify(FlaskHealthCheck.healthcheck())\n```\n\n# Example Return Value\n\nWhen the endpoint is called from your API, an expected 200 response would look like the following:\n\n```javascript\n{\n  \"HealthCheckResponse\": {\n    \"AppVersion\": \"1.0.0\",                  //The app version\n    \"Config\": {     \n      \"CurDir\": \"/opt/apps/MyWebAPI\",       //Root directory of your API\n      \"IsSuccess\": \"true\",                  //API is reachable (this is a 'to-be-configured' state)\n      \"MachineName\": \"MyMachineName\",       //The hostname of the box it's being run on\n      \"PyVersion\": \"3.7.0 (default, Sep 24 2018, 12:47:32) \\n[GCC 4.8.5 20150623 (Red Hat 4.8.5-28)]\",\n      \"Uptime\": 126.47574424743652,         //How long (in seconds) the service has been up for\n      \"User\": \"WebAPIUser\"                  //The user which is running the service\n    }\n  }\n}\n```\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://github.otpp.com/DevOps/FlaskHealthCheck",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "flask-otpp-healthcheck",
        "package_url": "https://pypi.org/project/flask-otpp-healthcheck/",
        "platform": "",
        "project_url": "https://pypi.org/project/flask-otpp-healthcheck/",
        "project_urls": {
            "Homepage": "http://github.otpp.com/DevOps/FlaskHealthCheck"
        },
        "release_url": "https://pypi.org/project/flask-otpp-healthcheck/0.0.4/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A package to return the health status of a flask application",
        "version": "0.0.4"
    },
    "last_serial": 4481903,
    "releases": {
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c6967924abd23c967a47d6ea80f86db7",
                    "sha256": "b0d10d30496725ed2a82c8ddcdf062dfc24c3bd14692d29388cde57dd9555d94"
                },
                "downloads": -1,
                "filename": "flask_otpp_healthcheck-0.0.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c6967924abd23c967a47d6ea80f86db7",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 4059,
                "upload_time": "2018-11-13T14:17:33",
                "url": "https://files.pythonhosted.org/packages/ad/5f/2a38c9fa3f9b5b159ca64d63182dd30bccfda3a9c85111f3618618b220ab/flask_otpp_healthcheck-0.0.4-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "aecb504fe98088d5e58d2c50f7b741a4",
                    "sha256": "46cf53188960c46462330b5f3b4e396ec94777aef18e53f3911b65498893b75d"
                },
                "downloads": -1,
                "filename": "flask_otpp_healthcheck-0.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "aecb504fe98088d5e58d2c50f7b741a4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2459,
                "upload_time": "2018-11-13T14:17:34",
                "url": "https://files.pythonhosted.org/packages/8f/6f/5f282398b78101d29ca3a56281b09280eac6f0b40363f6674f746f45cc47/flask_otpp_healthcheck-0.0.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c6967924abd23c967a47d6ea80f86db7",
                "sha256": "b0d10d30496725ed2a82c8ddcdf062dfc24c3bd14692d29388cde57dd9555d94"
            },
            "downloads": -1,
            "filename": "flask_otpp_healthcheck-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c6967924abd23c967a47d6ea80f86db7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4059,
            "upload_time": "2018-11-13T14:17:33",
            "url": "https://files.pythonhosted.org/packages/ad/5f/2a38c9fa3f9b5b159ca64d63182dd30bccfda3a9c85111f3618618b220ab/flask_otpp_healthcheck-0.0.4-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "aecb504fe98088d5e58d2c50f7b741a4",
                "sha256": "46cf53188960c46462330b5f3b4e396ec94777aef18e53f3911b65498893b75d"
            },
            "downloads": -1,
            "filename": "flask_otpp_healthcheck-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "aecb504fe98088d5e58d2c50f7b741a4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 2459,
            "upload_time": "2018-11-13T14:17:34",
            "url": "https://files.pythonhosted.org/packages/8f/6f/5f282398b78101d29ca3a56281b09280eac6f0b40363f6674f746f45cc47/flask_otpp_healthcheck-0.0.4.tar.gz"
        }
    ]
}