From da044d55dfc532e2ad4065e7823721dbdc5c7937 Mon Sep 17 00:00:00 2001 From: Sai Sharan Tangeda Date: Tue, 28 Nov 2023 10:51:49 +0530 Subject: [PATCH] Initialise SDK --- .github/CODEOWNERS | 4 + .github/PULL_REQUEST_TEMPLATE.md | 45 ++++ .github/workflows/deploy.yaml | 27 +++ .gitignore | 171 +++++++++++++++ LICENSE | 201 ++++++++++++++++++ MANIFEST.in | 1 + README.md | 8 + requirements.txt | 9 + setup.py | 24 +++ xpuls_fastapi_utils/__init__.py | 0 xpuls_fastapi_utils/constants/__init__.py | 0 xpuls_fastapi_utils/core/__init__.py | 0 xpuls_fastapi_utils/core/common.py | 43 ++++ xpuls_fastapi_utils/logging/__init__.py | 1 + .../logging/fastapi_log_config.py | 30 +++ xpuls_fastapi_utils/logging/setup_logger.py | 6 + xpuls_fastapi_utils/server/__init__.py | 1 + xpuls_fastapi_utils/server/common.py | 14 ++ .../server/routers/__init__.py | 1 + .../server/routers/telemetry.py | 10 + xpuls_fastapi_utils/telemetry/__init__.py | 0 xpuls_fastapi_utils/utils/__init__.py | 0 22 files changed, 596 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/workflows/deploy.yaml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 100644 README.md create mode 100644 requirements.txt create mode 100644 setup.py create mode 100644 xpuls_fastapi_utils/__init__.py create mode 100644 xpuls_fastapi_utils/constants/__init__.py create mode 100644 xpuls_fastapi_utils/core/__init__.py create mode 100644 xpuls_fastapi_utils/core/common.py create mode 100644 xpuls_fastapi_utils/logging/__init__.py create mode 100644 xpuls_fastapi_utils/logging/fastapi_log_config.py create mode 100644 xpuls_fastapi_utils/logging/setup_logger.py create mode 100644 xpuls_fastapi_utils/server/__init__.py create mode 100644 xpuls_fastapi_utils/server/common.py create mode 100644 xpuls_fastapi_utils/server/routers/__init__.py create mode 100644 xpuls_fastapi_utils/server/routers/telemetry.py create mode 100644 xpuls_fastapi_utils/telemetry/__init__.py create mode 100644 xpuls_fastapi_utils/utils/__init__.py diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..6b7ef3a --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,4 @@ +# This is a comment. +# Read more here https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-file-location + +* @SHARANTANGEDA diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..615083b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,45 @@ +## What does this PR address? + + +Thanks for sending a pull request! + + + + + +Fixes #(issue) + +## Before submitting: + + + + + +- [ ] Does the Pull Request follow [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#summary) naming? Here are [GitHub's + guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) on how to create a pull request. +- [ ] Does the code follow mlmonitor's code style, `pre-commit run -a` script has passed ? +- [ ] Did your changes require updates to the documentation? Have you updated + those accordingly? +- [ ] Did you write tests to cover your changes? diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml new file mode 100644 index 0000000..8f804f5 --- /dev/null +++ b/.github/workflows/deploy.yaml @@ -0,0 +1,27 @@ +name: pypi-release +on: + push: + tags: + - v* +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.11' + - name: Install dependencies + run: python -m pip install --upgrade build + - name: Build + run: python -m build + - name: Publish to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 + with: + password: ${{ secrets.PYPI_PUBLIC_TOKEN }} + - name: Archive + uses: actions/upload-artifact@v3 + with: + name: dist + path: dist/* diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7254d4e --- /dev/null +++ b/.gitignore @@ -0,0 +1,171 @@ +**/__pycache__ +*.egg* +build +.idea +/dist/* +.DS* +**/venv +**/dist +.ipynb_checkpoints/** +.vscode/** + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..954ccdc --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright (c) 2023 - Cognicraft Technologies + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..f9bd145 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1 @@ +include requirements.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..52bff48 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# 🧰 FastAPI utils by xpuls-labs +This is a thin wrapper around FastAPI to centralize telemetry, logs, config management and other items + +This also maintains the reusable utilities and hooks that can be shared across projects +### How to install? +```shell +pip install xpuls-fastapi-utils +``` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..5663adc --- /dev/null +++ b/requirements.txt @@ -0,0 +1,9 @@ +setuptools +wheel +pydantic +pyyaml +fastapi +uvicorn[standard] +starlette-exporter +starlette +pytest diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..bf2bbbe --- /dev/null +++ b/setup.py @@ -0,0 +1,24 @@ +from setuptools import setup, find_packages + +REQUIRED_PACKAGES = list(filter(None, list(map(lambda s: s.strip(), open('requirements.txt').readlines())))) + +with open("README.md", "r") as readme: + long_description = readme.read() +setup( + name='xpuls-fastapi-utils', + version="0.0.1", + author="Sai Sharan Tangeda", + author_email="saisarantangeda@gmail.com", + description="Base SDK for FastAPI Utils", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://github.com/xpuls-labs/fastapi-utils", + install_requires=REQUIRED_PACKAGES, + include_package_data=True, + packages=find_packages(), + classifiers=[ + 'Programming Language :: Python :: 2.7' + "Programming Language :: Python :: 3", + "Operating System :: OS Independent", + ], +) diff --git a/xpuls_fastapi_utils/__init__.py b/xpuls_fastapi_utils/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/xpuls_fastapi_utils/constants/__init__.py b/xpuls_fastapi_utils/constants/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/xpuls_fastapi_utils/core/__init__.py b/xpuls_fastapi_utils/core/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/xpuls_fastapi_utils/core/common.py b/xpuls_fastapi_utils/core/common.py new file mode 100644 index 0000000..9a0088a --- /dev/null +++ b/xpuls_fastapi_utils/core/common.py @@ -0,0 +1,43 @@ +import os.path + + +def __get_info_from_pod(key_name): + file_path = f"/etc/podinfo/{key_name}" + if os.path.exists(file_path): + file = open(file_path, "r") + return ''.join(file.readlines()) + return None + + +def __get_pod_name(): + pod_name = os.getenv("POD_NAME", None) if os.getenv("POD_NAME", None) is not None else __get_info_from_pod("name") + return pod_name if pod_name is not None else "local" + + +def __get_container_name(): + labels = __get_info_from_pod("labels") if __get_info_from_pod("labels") is not None else "local" + if not labels == "local": + container_label = [s for s in labels.split("\n") if "app.kubernetes.io/name=" in s] + if len(container_label) == 0: + return labels + container_name = container_label[0].split("=", 1)[1] + return container_name[1: len(container_name)-1] + return labels + + +def __get_service_version(): + labels = __get_info_from_pod("labels") if __get_info_from_pod("labels") is not None else "local" + if not labels == "local": + container_label = [s for s in labels.split("\n") if "app.kubernetes.io/version=" in s] + if len(container_label) == 0: + return labels + container_name = container_label[0].split("=", 1)[1] + return container_name[1: len(container_name)-1] + return labels + + +NAMESPACE = __get_info_from_pod("namespace") if __get_info_from_pod("namespace") is not None else "local" +POD_NAME = __get_pod_name() +CONTAINER_NAME = __get_container_name() +SERVICE_VERSION = __get_service_version() +NODE_IP = os.getenv("node-ip", None) if os.getenv("node-ip", None) is not None else __get_info_from_pod("node-ip") diff --git a/xpuls_fastapi_utils/logging/__init__.py b/xpuls_fastapi_utils/logging/__init__.py new file mode 100644 index 0000000..53a3c7b --- /dev/null +++ b/xpuls_fastapi_utils/logging/__init__.py @@ -0,0 +1 @@ +from .setup_logger import logger diff --git a/xpuls_fastapi_utils/logging/fastapi_log_config.py b/xpuls_fastapi_utils/logging/fastapi_log_config.py new file mode 100644 index 0000000..808a2d4 --- /dev/null +++ b/xpuls_fastapi_utils/logging/fastapi_log_config.py @@ -0,0 +1,30 @@ +from pydantic import BaseModel + + +class FALogConfig(BaseModel): + """Logging configuration to be set for the server""" + + LOGGER_NAME: str = "default" + LOG_FORMAT: str = "%(levelprefix)s | %(asctime)s | %(message)s" + LOG_LEVEL: str = "DEBUG" + + # Logging config + version = 1 + disable_existing_loggers = False + formatters = { + "default": { + "()": "uvicorn.logging.DefaultFormatter", + "fmt": LOG_FORMAT, + "datefmt": "%Y-%m-%d %H:%M:%S", + }, + } + handlers = { + "default": { + "formatter": "default", + "class": "logging.StreamHandler", + "stream": "ext://sys.stderr", + }, + } + loggers = { + "default": {"handlers": ["default"], "level": LOG_LEVEL}, + } diff --git a/xpuls_fastapi_utils/logging/setup_logger.py b/xpuls_fastapi_utils/logging/setup_logger.py new file mode 100644 index 0000000..5e52535 --- /dev/null +++ b/xpuls_fastapi_utils/logging/setup_logger.py @@ -0,0 +1,6 @@ +import logging +from logging.config import dictConfig + +from xpuls_fastapi_utils.logging.fastapi_log_config import FALogConfig +dictConfig(FALogConfig().dict()) +logger = logging.getLogger("default") diff --git a/xpuls_fastapi_utils/server/__init__.py b/xpuls_fastapi_utils/server/__init__.py new file mode 100644 index 0000000..5d89882 --- /dev/null +++ b/xpuls_fastapi_utils/server/__init__.py @@ -0,0 +1 @@ +from .common import instrument_server diff --git a/xpuls_fastapi_utils/server/common.py b/xpuls_fastapi_utils/server/common.py new file mode 100644 index 0000000..52c602d --- /dev/null +++ b/xpuls_fastapi_utils/server/common.py @@ -0,0 +1,14 @@ +from fastapi import FastAPI +from starlette.middleware.gzip import GZipMiddleware +from starlette_exporter import PrometheusMiddleware, handle_metrics + +from xpuls_fastapi_utils.server.routers import TelemetryAPI + + +def instrument_server(service_name: str, app: FastAPI): + app.add_middleware(GZipMiddleware, minimum_size=1000) + app.add_middleware(PrometheusMiddleware, app_name=service_name, group_paths=True) + app.add_route("/metrics", handle_metrics) + + app.include_router(TelemetryAPI().router) + return app diff --git a/xpuls_fastapi_utils/server/routers/__init__.py b/xpuls_fastapi_utils/server/routers/__init__.py new file mode 100644 index 0000000..50e6662 --- /dev/null +++ b/xpuls_fastapi_utils/server/routers/__init__.py @@ -0,0 +1 @@ +from .telemetry import TelemetryAPI diff --git a/xpuls_fastapi_utils/server/routers/telemetry.py b/xpuls_fastapi_utils/server/routers/telemetry.py new file mode 100644 index 0000000..0896941 --- /dev/null +++ b/xpuls_fastapi_utils/server/routers/telemetry.py @@ -0,0 +1,10 @@ +from fastapi import APIRouter + + +class TelemetryAPI: + def __init__(self) -> None: + self.router = APIRouter() + self.router.add_api_route("/healthcheck", self.healthcheck_endpoint, methods=["GET"]) + + async def healthcheck_endpoint(self): + return "!pong" diff --git a/xpuls_fastapi_utils/telemetry/__init__.py b/xpuls_fastapi_utils/telemetry/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/xpuls_fastapi_utils/utils/__init__.py b/xpuls_fastapi_utils/utils/__init__.py new file mode 100644 index 0000000..e69de29