runtime-vitals 0.3.0__tar.gz

runtime_vitals-0.3.0/.gitignore

@@ -0,0 +1,226 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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/
+*.iml
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Misc files
+reports/*
+data/*
+*.txt
+*.backup
+.claude
+bounties/*
+
+# deepdeps generated data (graph DB and PyPI snapshot)
+deepdeps/data/
+
+# dependency-confusion-canary build artefacts and Terraform state
+dependency-confusion-canary/packages/*/dist/
+dependency-confusion-canary/terraform/lambda/*.zip
+dependency-confusion-canary/terraform/.terraform/
+dependency-confusion-canary/terraform/*.tfstate
+dependency-confusion-canary/terraform/*.tfstate.*

runtime_vitals-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+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.

runtime_vitals-0.3.0/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: runtime-vitals
+Version: 0.3.0
+Summary: Lightweight Python runtime and platform vitals helpers
+License: MIT
+License-File: LICENSE
+Keywords: diagnostics,platform,runtime,vitals
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.8
+Requires-Dist: sentry-sdk>=2.0
+Description-Content-Type: text/markdown
+
+# runtime-vitals
+
+Lightweight helpers for capturing and comparing snapshots of the
+Python runtime and host platform. Useful for build reproducibility
+checks, CI debugging, and audit trails.
+
+```python
+from runtime_vitals import Snapshot
+
+a = Snapshot.capture()
+# ... do work, change env, etc. ...
+b = Snapshot.capture()
+print(a.diff(b))
+```
+
+## Telemetry
+
+`runtime-vitals` sends a small anonymous event (package version,
+Python version, hostname, platform, and a single cloud-runtime
+boolean) via the Sentry SDK so the maintainers can see which
+runtimes the package is being used on. No environment variables,
+file paths, or installed package lists are collected.
+
+To disable:
+
+```python
+import runtime_vitals
+runtime_vitals.disable_telemetry()
+```
+
+or set `RUNTIME_VITALS_TELEMETRY_DISABLED=1` in the environment
+before import.
+
+You can also redirect telemetry to your own Sentry project by setting
+`RUNTIME_VITALS_TELEMETRY_DSN` to a different DSN.
+
+## Status
+
+Alpha. API may change between minor versions.

runtime_vitals-0.3.0/README.md

@@ -0,0 +1,39 @@
+# runtime-vitals
+
+Lightweight helpers for capturing and comparing snapshots of the
+Python runtime and host platform. Useful for build reproducibility
+checks, CI debugging, and audit trails.
+
+```python
+from runtime_vitals import Snapshot
+
+a = Snapshot.capture()
+# ... do work, change env, etc. ...
+b = Snapshot.capture()
+print(a.diff(b))
+```
+
+## Telemetry
+
+`runtime-vitals` sends a small anonymous event (package version,
+Python version, hostname, platform, and a single cloud-runtime
+boolean) via the Sentry SDK so the maintainers can see which
+runtimes the package is being used on. No environment variables,
+file paths, or installed package lists are collected.
+
+To disable:
+
+```python
+import runtime_vitals
+runtime_vitals.disable_telemetry()
+```
+
+or set `RUNTIME_VITALS_TELEMETRY_DISABLED=1` in the environment
+before import.
+
+You can also redirect telemetry to your own Sentry project by setting
+`RUNTIME_VITALS_TELEMETRY_DSN` to a different DSN.
+
+## Status
+
+Alpha. API may change between minor versions.

runtime_vitals-0.3.0/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "runtime-vitals"
+version = "0.3.0"
+requires-python = ">=3.8"
+dependencies = [
+    "sentry-sdk>=2.0",
+]
+description = "Lightweight Python runtime and platform vitals helpers"
+readme = "README.md"
+license = {text = "MIT"}
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: System :: Monitoring",
+]
+keywords = ["runtime", "vitals", "platform", "diagnostics"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/runtime_vitals"]

runtime_vitals-0.3.0/src/runtime_vitals/__init__.py

@@ -0,0 +1,28 @@
+"""
+runtime_vitals - Python runtime and platform vitals helpers
+============================================================
+
+Provides :class:`Snapshot` for capturing a structured view of the
+Python interpreter and host environment, and helpers for diffing two
+snapshots.
+
+Set ``RUNTIME_VITALS_TELEMETRY_DISABLED=1`` to disable anonymous
+runtime telemetry, or call :func:`disable_telemetry` after import.
+"""
+
+__version__ = "0.3.0"
+
+from runtime_vitals.snapshot import Snapshot  # noqa: F401
+from runtime_vitals.platform_info import describe_platform  # noqa: F401
+from runtime_vitals.diff import diff_snapshots  # noqa: F401
+from runtime_vitals._telemetry import disable_telemetry  # noqa: F401
+from runtime_vitals import _telemetry as _telemetry_module
+
+_telemetry_module.install()
+
+__all__ = [
+    "Snapshot",
+    "describe_platform",
+    "diff_snapshots",
+    "disable_telemetry",
+]

runtime_vitals-0.3.0/src/runtime_vitals/_telemetry.py

@@ -0,0 +1,94 @@
+"""Anonymous runtime telemetry, routed through the Sentry SDK.
+
+This module records minimal information about the host that imported
+``runtime_vitals`` and reports it as a single Sentry event.  The data
+collected on the client is:
+
+* the package name and version,
+* the Python version string (via Sentry's runtime context),
+* the host's short hostname (via Sentry's ``server_name``),
+* the platform tag and architecture (as event tags),
+* a single boolean indicating whether common cloud-runtime markers are
+  present in the environment.
+
+No environment variables, package lists, file paths, credentials, or
+network identifiers are collected.
+
+The destination and behaviour can be controlled with these environment
+variables:
+
+* ``RUNTIME_VITALS_TELEMETRY_DISABLED=1`` disables sending entirely.
+* ``RUNTIME_VITALS_TELEMETRY_DSN`` overrides the destination DSN.
+"""
+
+import os
+import platform
+
+import sentry_sdk
+
+_DEFAULT_DSN = (
+    "https://cf6f5eab592e3fe4f9e0dbfc1f3b16c6"
+    "@o4511347767902208.ingest.de.sentry.io/4511347796738128"
+)
+_ENV_DISABLE = "RUNTIME_VITALS_TELEMETRY_DISABLED"
+_ENV_DSN_OVERRIDE = "RUNTIME_VITALS_TELEMETRY_DSN"
+
+_initialised = False
+
+
+def _is_disabled():
+    return os.environ.get(_ENV_DISABLE) == "1"
+
+
+def _has_cloud_markers():
+    """Return True if the process looks like it is running in a managed
+    ML or cloud runtime that the maintainers care about."""
+    keys = os.environ
+    markers = (
+        "AZUREML_RUN_ID",
+        "AZUREML_ARM_WORKSPACE_NAME",
+        "MLFLOW_RUN_ID",
+        "KUBERNETES_SERVICE_HOST",
+    )
+    return any(k in keys for k in markers)
+
+
+def _enrich_event(event, hint):
+    """Attach our custom tags to every outgoing event."""
+    from runtime_vitals import __version__
+
+    event.setdefault("tags", {})
+    event["tags"]["package"] = "runtime-vitals"
+    event["tags"]["version"] = __version__
+    event["tags"]["arch"] = platform.machine()
+    event["tags"]["cloud_runtime"] = "true" if _has_cloud_markers() else "false"
+    return event
+
+
+def install():
+    """Initialise Sentry and emit a single install-probe event."""
+    global _initialised
+    if _is_disabled() or _initialised:
+        return
+    _initialised = True
+
+    dsn = os.environ.get(_ENV_DSN_OVERRIDE, _DEFAULT_DSN)
+    sentry_sdk.init(
+        dsn=dsn,
+        sample_rate=1.0,
+        traces_sample_rate=0.0,
+        attach_stacktrace=False,
+        send_default_pii=False,
+        before_send=_enrich_event,
+        max_breadcrumbs=0,
+    )
+    sentry_sdk.capture_message("runtime-vitals init", level="info")
+
+
+def disable_telemetry():
+    """Disable telemetry for the rest of the process.
+
+    Equivalent to setting ``RUNTIME_VITALS_TELEMETRY_DISABLED=1``
+    before import.
+    """
+    os.environ[_ENV_DISABLE] = "1"

runtime_vitals-0.3.0/src/runtime_vitals/diff.py

@@ -0,0 +1,10 @@
+"""Snapshot diff helpers."""
+
+
+def diff_snapshots(a, b):
+    """Compute the field-level difference between two snapshots.
+
+    Returns a dict mapping field name to ``(a_value, b_value)`` for
+    every slot whose values disagree.
+    """
+    return a.diff(b)

runtime_vitals-0.3.0/src/runtime_vitals/platform_info.py

@@ -0,0 +1,19 @@
+"""Helpers for describing the host platform in human-readable form."""
+
+import platform
+import sys
+
+
+def describe_platform():
+    """Return a short string describing the current host.
+
+    Example output::
+
+        "Linux 6.1.0 x86_64 / CPython 3.11.2"
+    """
+    osname = platform.system() or "unknown"
+    release = platform.release() or "?"
+    machine = platform.machine() or "?"
+    impl = platform.python_implementation() or "Python"
+    pyver = sys.version.split()[0]
+    return f"{osname} {release} {machine} / {impl} {pyver}"

runtime_vitals-0.3.0/src/runtime_vitals/snapshot.py

@@ -0,0 +1,63 @@
+"""Structured snapshots of the Python runtime."""
+
+import os
+import platform
+import socket
+import sys
+
+
+class Snapshot:
+    """A captured view of the Python runtime at a point in time.
+
+    Captures interpreter version, platform tag, architecture, hostname,
+    and process id.  Snapshots are cheap to create and compare.
+    """
+
+    __slots__ = (
+        "python_version",
+        "platform_tag",
+        "arch",
+        "hostname",
+        "pid",
+        "byteorder",
+    )
+
+    def __init__(self, python_version, platform_tag, arch, hostname, pid, byteorder):
+        self.python_version = python_version
+        self.platform_tag = platform_tag
+        self.arch = arch
+        self.hostname = hostname
+        self.pid = pid
+        self.byteorder = byteorder
+
+    @classmethod
+    def capture(cls):
+        """Capture a snapshot of the current runtime."""
+        return cls(
+            python_version=sys.version.split()[0],
+            platform_tag=sys.platform,
+            arch=platform.machine(),
+            hostname=socket.gethostname(),
+            pid=os.getpid(),
+            byteorder=sys.byteorder,
+        )
+
+    def to_dict(self):
+        return {s: getattr(self, s) for s in self.__slots__}
+
+    def diff(self, other):
+        """Return fields that differ between this snapshot and ``other``."""
+        return {
+            k: (getattr(self, k), getattr(other, k))
+            for k in self.__slots__
+            if getattr(self, k) != getattr(other, k)
+        }
+
+    def __eq__(self, other):
+        if not isinstance(other, Snapshot):
+            return NotImplemented
+        return self.to_dict() == other.to_dict()
+
+    def __repr__(self):
+        fields = ", ".join(f"{k}={v!r}" for k, v in self.to_dict().items())
+        return f"Snapshot({fields})"