probirka 0.3.0a1__tar.gz

probirka-0.3.0a1/.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_size = 4
+
+[{Makefile,**.mk}]
+indent_style = tab
+
+[*.{md,txt,rst}]
+trim_trailing_whitespace = false

probirka-0.3.0a1/.github/workflows/pypi.yml

@@ -0,0 +1,25 @@
+---
+name: pypi
+
+on:
+  release:
+    types: [ created ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Extract branch name
+        shell: bash
+        run: |
+          echo "##[set-output name=ver;]$(echo ${GITHUB_REF#refs/*/})"
+        id: extract_name_and_version
+      - run: sed -i 's/0.0.0/'"${{ steps.extract_name_and_version.outputs.ver }}"'/' pyproject.toml
+      - run: head -n 10 pyproject.toml
+      - run: sed -i 's/0.0.0/'"${{ steps.extract_name_and_version.outputs.ver }}"'/' probirka/__init__.py
+      - uses: astral-sh/setup-uv@v4
+      - run: uv python install 3.12
+      - run: uv sync --all-extras --dev
+      - run: uv build
+      - run: uv publish --username __token__ --password ${{ secrets.PYPI_TOKEN }}

probirka-0.3.0a1/.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+---
+name: tests
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    env:
+      SOURCES_DIR: sources
+    strategy:
+      matrix:
+        just-trigger:
+          - "lint"
+          - "tests"
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v2
+      - uses: astral-sh/setup-uv@v4
+      - run: uv python install ${{ matrix.python-version }}
+      - run: uv sync --all-extras --dev
+      - run: just ${{ matrix.just-trigger }}

probirka-0.3.0a1/.gitignore

@@ -0,0 +1,164 @@
+.python-version
+.idea/
+# 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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/

probirka-0.3.0a1/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+---
+default_install_hook_types:
+  - pre-commit
+
+repos:
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: python -m mypy
+        language: system
+        'types_or': [ python, pyi ]
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.8.1"
+    hooks:
+      - id: ruff
+        args: [ --fix, --unsafe-fixes ]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v5.0.0"
+    hooks:
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: check-json
+      - id: check-toml
+      - id: check-yaml
+      - id: double-quote-string-fixer
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        exclude: ^.+(\.md)$

probirka-0.3.0a1/PKG-INFO

@@ -0,0 +1,264 @@
+Metadata-Version: 2.3
+Name: probirka
+Version: 0.3.0a1
+Summary: Add your description here
+Project-URL: Repository, https://github.com/appKODE/probirka
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# 🧪: PROBIRKA 
+
+Async health checks for monitoring purposes
+
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![PyPI](https://img.shields.io/pypi/v/probirka.svg)](https://pypi.python.org/pypi/probirka)
+[![PyPI](https://img.shields.io/pypi/dm/probirka.svg)](https://pypi.python.org/pypi/probirka)
+
+## Installation
+
+```shell
+pip install probirka
+```
+
+## Basic usage
+
+```python
+from asyncio import sleep, run
+from dataclasses import asdict
+from pprint import pprint
+
+from probirka import Probirka, make_fastapi_endpoint
+
+checks = Probirka()
+checks.add_info("project", "example")
+checks.add_info("version", "0.1.0")
+
+
+@checks.add()
+def ok_check():
+  5 / 1
+
+
+@checks.add()
+def error_check():
+  5 / 0
+
+
+@checks.add()
+async def async_check():
+  await sleep(1)
+
+
+async def main():
+  results = await checks.run()
+  pprint(asdict(results))
+
+
+if __name__ == "__main__":
+  run(main())
+
+# {'elapsed': datetime.timedelta(seconds=1, microseconds=1506),
+#  'extra': {'project': 'example', 'version': '0.1.0'},
+#  'ok': False,
+#  'results': [{'elapsed': datetime.timedelta(microseconds=7),
+#               'error': None,
+#               'name': 'ok_check',
+#               'ok': True,
+#               'started_at': datetime.datetime(2024, 6, 4, 23, 1, 53, 471363)},
+#              {'elapsed': datetime.timedelta(microseconds=4),
+#               'error': 'division by zero',
+#               'name': 'error_check',
+#               'ok': False,
+#               'started_at': datetime.datetime(2024, 6, 4, 23, 1, 53, 471376)},
+#              {'elapsed': datetime.timedelta(seconds=1, microseconds=1259),
+#               'error': None,
+#               'name': 'async_check',
+#               'ok': True,
+#               'started_at': datetime.datetime(2024, 6, 4, 23, 1, 53, 471383)}],
+#  'started_at': datetime.datetime(2024, 6, 4, 23, 1, 53, 471324)}
+```
+
+## Custom probes
+
+```python
+from asyncio import run
+import os
+from typing import Optional
+
+import asyncpg
+from probirka import ProbeBase, Probirka
+
+
+class PGCheck(
+  ProbeBase,
+):
+  def __init__(
+    self,
+    dsn: str,
+    name: Optional[str] = None,
+    timeout: Optional[int] = None,
+    is_optional: bool = False,
+  ) -> None:
+    self._dsn = dsn
+    super().__init__(
+      name=name,
+      timeout=timeout,
+      is_optional=is_optional,
+    )
+
+  async def _check(
+    self,
+  ) -> Optional[bool]:
+    conn = None
+    try:
+      conn = await asyncpg.connect(dsn=self._dsn)
+      await conn.fetch("SELECT 1")
+    finally:
+      if conn:
+        await conn.close()
+    return True
+
+
+checks = Probirka()
+
+
+async def main():
+  checks.add_probe(
+    PGCheck(dsn=os.environ['PG_DSN']),
+  )
+  results = await checks.run()
+  assert results.ok
+
+
+if __name__ == "__main__":
+  run(main())
+```
+
+## Mask your secrets
+
+```python
+from asyncio import run
+from dataclasses import asdict
+from pprint import pprint
+
+from probirka import Probirka, JsonRegularTypes
+
+
+def mask_sensitive_data(
+    name: str,
+    value: JsonRegularTypes,
+) -> JsonRegularTypes:
+    if "secret" in name or "secret" in value:
+        return "***"
+    return value
+
+
+checks = Probirka(
+    mask_sensitive_info_data_cb=mask_sensitive_data,
+)
+checks.add_info("project", "example")
+checks.add_info("version", "0.1.0")
+checks.add_info("top_secret_one", "wow")
+checks.add_info(
+    "settings",
+    {
+        "top_secret_two": 123456,
+        "foo": "bar",
+        "baz": ["top@secret", "something"],
+    },
+)
+
+
+async def main():
+    results = await checks.run()
+    pprint(asdict(results))
+
+
+if __name__ == "__main__":
+    run(main())
+
+
+# {'checks': [],
+#  'info': {'project': 'example',
+#           'settings': {'baz': ['***', 'something'],
+#                        'foo': 'bar',
+#                        'top_secret_two': '***'},
+#           'top_secret_one': '***',
+#           'version': '0.1.0'},
+#  'ok': True,
+#  'started_at': datetime.datetime(2024, 6, 5, 10, 56, 20, 736558),
+#  'total_elapsed': datetime.timedelta(microseconds=10)}
+```
+
+## FastAPI endpoint
+
+```python
+from fastapi import FastAPI
+from uvicorn import run
+
+from probirka import Probirka, make_fastapi_endpoint
+
+app = FastAPI()
+
+checks = Probirka()
+checks.add_info("project", "fastapi example")
+checks.add_info("version", "0.1.0")
+
+
+@checks.add()
+def empty_check():
+  pass
+
+
+if __name__ == "__main__":
+  app.add_api_route(
+    "/health",
+    endpoint=make_fastapi_endpoint(checks, return_results=False),
+  )
+  app.add_api_route(
+    "/self-check",
+    endpoint=make_fastapi_endpoint(checks, with_optional=True),
+  )
+  run(app)
+```
+
+
+## AIOHTTP endpoint
+
+```python
+from aiohttp import web
+
+from probirka import Probirka, make_aiohttp_endpoint
+
+app = web.Application()
+
+checks = Probirka()
+checks.add_info("project", "fastapi example")
+checks.add_info("version", "0.1.0")
+
+
+@checks.add()
+def empty_check():
+    pass
+
+
+if __name__ == "__main__":
+    app.router.add_get(
+        "/health",
+        handler=make_aiohttp_endpoint(checks, return_results=False),
+    )
+    app.router.add_get(
+        "/self-check",
+        handler=make_aiohttp_endpoint(checks, with_optional=True),
+    )
+    web.run_app(app)
+```