healthy-api 0.10.0__py3-none-any.whl

healthy_api/__init__.py

@@ -0,0 +1,27 @@
+__version__ = "0.10.0"
+
+import os
+
+from typing import Type, TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    from .adapters.fastapi import FastapiAdapter
+    from .adapters.flask import FlaskAdapter
+
+    T_FlaskAdapter = Type[FlaskAdapter]
+    T_FastApiAdapter = Type[FastapiAdapter]
+
+
+def load_adapter() -> Union["T_FlaskAdapter", "T_FastApiAdapter"]:
+    framework = os.getenv("HAPI_WEB_FRAMEWORK")
+
+    if framework == "flask":
+        from .adapters.flask import FlaskAdapter
+
+        return FlaskAdapter
+    elif framework == "fastapi":
+        from .adapters.fastapi import FastapiAdapter
+
+        return FastapiAdapter
+    else:
+        raise ValueError("You must specify a web framework (flask/fastapi)")

healthy_api/adapters/base_adapter.py

@@ -0,0 +1,103 @@
+import sys
+from abc import ABC, abstractmethod
+from datetime import datetime
+from typing import Callable, Dict, List, Optional, TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    from .fastapi import FastApiApplication
+    from .flask import FlaskApplication
+
+from ..git import git_stats, GitReturn
+from ..version import read_version_file
+
+if sys.version_info >= (3, 8):
+    from typing import Literal
+else:
+    from typing_extensions import Literal
+
+SupportedApplication = Union["FlaskApplication", "FastApiApplication"]
+FuncList = List[Callable]
+
+ResponseJson = Dict[
+    Union[Literal["uptime"], Literal["app"], Literal["status"], Literal["git"], str],
+    Union[str, Literal["OK"], Literal["DOWN"], GitReturn],
+]
+
+
+class BaseAdapter(ABC):
+    DEFAULT_ENABLE = True
+    DEFAULT_ENABLE_GIT = True
+    DEFAULT_ENABLE_VERSION = True
+    DEFAULT_ENDPOINT = "/_health"
+
+    def __init__(
+        self,
+        app: Optional[SupportedApplication] = None,
+        extra_checks: Optional[FuncList] = None,
+    ) -> None:
+        if app is not None:
+            check_fns = extra_checks if extra_checks is not None else []
+            self.init_app(app, check_fns)
+
+    def init_app(
+        self,
+        app: Optional[SupportedApplication],
+        extra_checks: Optional[FuncList] = None,
+    ) -> None:
+        if app is None:
+            raise ValueError("None is not a valid application")
+
+        self.app = app
+        self.extra_checks = extra_checks if extra_checks is not None else []
+        self.start_time = datetime.now()
+        self.config = self.load_config()
+        self.logger = self.get_logger()
+
+        if self.config["HAPI_ENABLE"]:
+            self.load_router()
+
+    def health(self):
+        data: ResponseJson = {
+            "uptime": str(datetime.now() - self.start_time),
+            "app": self.app_name(),
+        }
+
+        raw_results: List[bool] = []
+        if self.extra_checks:
+            results = {}
+            for func in self.extra_checks:
+                try:
+                    res: bool = func()
+                    raw_results.append(res)
+                except Exception as e:
+                    self.logger.error(f"Error in healthcheck: {str(e)}")
+                    res = False
+
+                results[func.__doc__] = "OK" if res else "DOWN"
+            data.update(results)
+
+        data["status"] = "OK" if all(raw_results) else "DOWN"
+
+        if self.config["HAPI_ENABLE_GIT"]:
+            data.update({"git": git_stats()})
+
+        if self.config["HAPI_ENABLE_VERSION"]:
+            data.update({"version": read_version_file()})
+
+        return self.json_response(data)
+
+    @abstractmethod
+    def get_logger(self) -> Callable:
+        raise NotImplementedError
+
+    @abstractmethod
+    def json_response(self, data: dict):
+        raise NotImplementedError
+
+    @abstractmethod
+    def load_config(self) -> dict:
+        raise NotImplementedError
+
+    @abstractmethod
+    def load_router(self) -> None:
+        raise NotImplementedError

healthy_api/adapters/fastapi.py

@@ -0,0 +1,41 @@
+import logging
+import os
+from fastapi import FastAPI
+from typing import Type, cast
+
+from .base_adapter import BaseAdapter
+
+FastApiApplication = Type[FastAPI]
+
+
+class FastapiAdapter(BaseAdapter):
+    def app_name(self) -> str:
+        app = cast(FastAPI, self.app)
+        return app.title
+
+    def get_logger(self):
+        return logging.getLogger()
+
+    def json_response(self, data: dict) -> dict:
+        # FastAPI will handle the json headers
+        return data
+
+    def load_config(self) -> dict:
+        return {
+            "HAPI_ENABLE": bool(int(os.environ.get("HAPI_ENABLE", self.DEFAULT_ENABLE))),
+            "HAPI_ENABLE_GIT": bool(
+                int(os.environ.get("HAPI_ENABLE_GIT", self.DEFAULT_ENABLE_GIT))
+            ),
+            "HAPI_ENABLE_VERSION": bool(
+                int(os.environ.get("HAPI_ENABLE_VERSION", self.DEFAULT_ENABLE_VERSION))
+            ),
+            "HAPI_ENDPOINT": os.environ.get("HAPI_ENDPOINT", self.DEFAULT_ENDPOINT),
+        }
+
+    def load_router(self) -> None:
+        app = cast(FastAPI, self.app)
+        endpoint = cast(str, self.config["HAPI_ENDPOINT"])
+
+        @app.get(path=endpoint)
+        def _health():
+            return self.health()

healthy_api/adapters/flask.py

@@ -0,0 +1,39 @@
+import flask
+from typing import Any, Dict, Type, cast
+
+from .base_adapter import BaseAdapter
+
+FlaskApplication = Type[flask.Flask]
+
+
+class FlaskAdapter(BaseAdapter):
+    def app_name(self) -> str:
+        app = cast(flask.Flask, self.app)
+        return app.name
+
+    def get_logger(self) -> Any:
+        app = cast(flask.Flask, self.app)
+        return app.logger
+
+    def json_response(self, data: dict) -> flask.Response:
+        return flask.jsonify(data)
+
+    def load_config(self) -> Dict[str, Any]:
+        app = cast(flask.Flask, self.app)
+        config = {
+            "HAPI_ENABLE": bool(int(app.config.get("HAPI_ENABLE", self.DEFAULT_ENABLE))),
+            "HAPI_ENABLE_GIT": bool(
+                int(app.config.get("HAPI_ENABLE_GIT", self.DEFAULT_ENABLE_GIT))
+            ),
+            "HAPI_ENABLE_VERSION": bool(
+                int(app.config.get("HAPI_ENABLE_VERSION", self.DEFAULT_ENABLE_VERSION))
+            ),
+            "HAPI_ENDPOINT": app.config.get("HAPI_ENDPOINT", self.DEFAULT_ENDPOINT),
+        }
+        app.config.update(config)
+        return config
+
+    def load_router(self) -> None:
+        app = cast(flask.Flask, self.app)
+        endpoint = cast(str, self.config["HAPI_ENDPOINT"])
+        app.add_url_rule(rule=endpoint, view_func=self.health)

healthy_api/git.py

@@ -0,0 +1,41 @@
+import re
+import sys
+import subprocess
+from typing import Union
+
+
+if sys.version_info >= (3, 8):
+    from typing import Literal, TypedDict
+else:
+    from typing_extensions import Literal, TypedDict
+
+
+class GitReturn(TypedDict):
+    commit: Union[str, Literal["Unknown"]]
+    author: Union[str, Literal["Unknown"]]
+    date: Union[str, Literal["Unknown"]]
+
+
+GIT_CMD = "git log | head -4"
+RE_COMMIT = re.compile(r"commit[\W]+(\w+)", re.MULTILINE)
+RE_AUTHOR = re.compile(r"Author\:[\W]+(.*)", re.MULTILINE)
+RE_DATE = re.compile(r"Date\:[\W]+(.*)", re.MULTILINE)
+
+
+def git_stats() -> GitReturn:
+    try:
+        ret = subprocess.check_output([GIT_CMD], shell=True).decode("utf-8")
+        commit = re.search(RE_COMMIT, ret)
+        author = re.search(RE_AUTHOR, ret)
+        date = re.search(RE_DATE, ret)
+        return {
+            "commit": commit.group(1) if commit else "Unknown",
+            "author": author.group(1) if author else "Unknown",
+            "date": date.group(1) if date else "Unknown",
+        }
+    except subprocess.CalledProcessError:
+        return {
+            "commit": "Unknown",
+            "author": "Unknown",
+            "date": "Unknown",
+        }

healthy_api/version.py

@@ -0,0 +1,9 @@
+import os
+
+
+def read_version_file() -> str:
+    path = os.path.join(os.getcwd(), ".version")
+    if os.path.exists(path):
+        with open(path, "r") as f:
+            return f.read().strip()
+    return ""

healthy_api-0.10.0.dist-info/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Herman Singh <kartstig@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

healthy_api-0.10.0.dist-info/LICENSE

@@ -0,0 +1,11 @@
+
+MIT License
+
+Copyright (c) 2017, Herman Paul Singh
+
+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.
+

healthy_api-0.10.0.dist-info/METADATA

@@ -0,0 +1,183 @@
+Metadata-Version: 2.1
+Name: healthy-api
+Version: 0.10.0
+Summary: Healthy-API adds a healthcheck endpoint for all web frameworks.
+Author-email: Herman Singh <kartstig@gmail.com>
+Maintainer-email: Herman Singh <kartstig@gmail.com>
+License: MIT License
+Project-URL: Donate, https://github.com/sponsors/Kartstig/dashboard
+Project-URL: Documentation, https://readthedocs.org/projects/healthy_api
+Project-URL: Source Code, https://github.com/Kartstig/healthy_api
+Project-URL: Issue Tracker, https://github.com/Kartstig/healthy_api/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Provides-Extra: all
+Requires-Dist: Flask >=0.12 ; extra == 'all'
+Requires-Dist: fastapi ; extra == 'all'
+Provides-Extra: fastapi
+Requires-Dist: fastapi ; extra == 'fastapi'
+Provides-Extra: flask
+Requires-Dist: Flask >=0.12 ; extra == 'flask'
+
+===============================
+Healthy-API
+===============================
+
+        Healthchecks for Any Framework (FastAPI/Flask)
+
+.. _FastAPI: https://github.com/tiangolo/fastapi/
+
+.. _Flask: https://github.com/pallets/flask/
+
+.. image:: https://img.shields.io/pypi/v/Healthy-API.svg
+        :target: https://pypi.python.org/pypi/Healthy-API
+        :alt: PyPI
+
+.. image:: https://github.com/Kartstig/healthy_api/actions/workflows/pytest.yml/badge.svg?branch=master
+        :target: https://github.com/Kartstig/healthy_api/actions/workflows/pytest.yml
+        :alt: GitHub Actions
+
+.. image:: https://readthedocs.org/projects/healthy-api/badge/?version=latest
+    :target: https://healthy-api.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. image:: https://codecov.io/gh/Kartstig/healthy_api/graph/badge.svg?token=mTG6WudJwK
+        :target: https://codecov.io/gh/Kartstig/healthy_api
+        :alt: Codecov
+
+.. image:: https://img.shields.io/pypi/dm/Healthy-API
+        :alt: PyPI - Downloads
+
+Healthy-API is designed to work with both Flask and FastAPI. Healthy-API is really simple
+to set up. Healthy-API will provide an enpoint at `/_health` where you will get a JSON response
+of the system's uptime, current git revision, version, and function you want.
+
+You can also add in extra checks by passing in a list of checks to the
+constructor.
+
+Installing
+----------
+
+Install and update using `pip`\:
+
+.. code-block:: text
+
+        pip install -U "healthy-api[flask]"
+
+or
+
+.. code-block:: text
+
+        pip install -U "healthy-api[fastapi]"
+
+FastAPI Configuration
+---------------------
+
+.. code-block:: python
+
+  from fastapi import FastAPI
+  from healthy_api.adapters.fastapi import FlaskAdapter as HealthyApi
+
+  app = FastAPI(__name__)
+
+  def db_check():
+    """Database"""
+    try:
+        with get_session_ctx() as session:
+            (res,) = session.execute(text("SELECT 1")).fetchone()
+            return bool(res == 1)
+    except Exception as e:
+        logger.error(f"Unable to connect to database: {e}")
+        return False
+
+  HealthyApi(app, extra_checks=[db_check])
+
+
+Flask Configuration
+-------------------
+
+.. code-block:: python
+
+  from Flask import Flask
+  from healthy_api.adapters.flask import Flask as HealthyApi
+
+  app = Flask(__name__)
+
+  HealthyApi(app)
+
+Or if you can use the `init_app` function:
+
+.. code-block:: python
+
+    from Flask import Flask
+    from healthy_api.adapters.flask import Flask as HealthyApi
+
+    app = Flask(__name__)
+
+    healthy_api = HealthyApi()
+    healthy_api.init_app(app)
+
+* Free software: MIT license
+* Documentation: https://healthy_api.readthedocs.io.
+
+
+Features
+--------
+
+* Current Git Commit
+* Current Version
+* Accepts custom functions
+
+
+Configuration
+-------------
+
++---------------------+---------------------------------+------+------------+
+| Config Key          | Description                     | Type | Default    |
++=====================+=================================+======+============+
+| HAPI_ENABLE         | Enable/Disable Healthy-API      | bool | True       |
++---------------------+---------------------------------+------+------------+
+| HAPI_ENABLE_GIT     | Enable/Disable Git Stats        | bool | True       |
++---------------------+---------------------------------+------+------------+
+| HAPI_ENABLE_VERSION | Enable/Disable Version Stats    | bool | True       |
++---------------------+---------------------------------+------+------------+
+| HAPI_ENDPOINT       | Custom Route                    | str  | /_health   |
++---------------------+---------------------------------+------+------------+
+
+
+Sponsorship
+-----------
+
+Put your logo here! `Become a sponsor`_ and support this project!
+
+.. _Become a sponsor: https://github.com/sponsors/Kartstig
+
+
+
+Credits
+-------
+
+This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
+

healthy_api-0.10.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+healthy_api/__init__.py,sha256=sPV_cS_2BLlXJeeZYNR0gl9xF06Fb-pHXzjhkC26ipM,708
+healthy_api/git.py,sha256=RHH0dmAqwleV9ywhY_CGfSaFdRsgtAaXZjCdBAJlK_4,1181
+healthy_api/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+healthy_api/version.py,sha256=p5GWoqYY8cTWmKSDQXYf6XO29-72hqZt8_VwXjsVSpk,207
+healthy_api/adapters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+healthy_api/adapters/base_adapter.py,sha256=iiVjuvQsRKEl3DsUV1pAEvlSYChVj99K_qkpbtW5dfw,2988
+healthy_api/adapters/fastapi.py,sha256=Q5fOZPqvQiJdkwTQTYe4cjjsL8WiwwoA-R7E3NGFkco,1204
+healthy_api/adapters/flask.py,sha256=g0gunAadltbHEUrSNqLbVlX6Wkmhr5hgaDrYhaE2Npg,1284
+healthy_api-0.10.0.dist-info/AUTHORS.rst,sha256=G4CE063JlrHhq5P8Whw2skts5wdl1YJHJRuaSbD-zLs,156
+healthy_api-0.10.0.dist-info/LICENSE,sha256=jZBIByrw8sUNYiSuqo4YApodjtgQIh7BjzmTcc5KCMU,1077
+healthy_api-0.10.0.dist-info/METADATA,sha256=b2LWpTEhdHq9T19D-jxUST4VwpxdxLTaycWPtDRd168,5757
+healthy_api-0.10.0.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+healthy_api-0.10.0.dist-info/top_level.txt,sha256=AcjTG-juyolwOC4A49yzM1Brfqw2szpPGC_UChYjoVc,16
+healthy_api-0.10.0.dist-info/RECORD,,

healthy_api-0.10.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.41.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

healthy_api-0.10.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+healthy_api
+lib