mldebug 0.0.1__tar.gz

mldebug-0.0.1/.editorconfig

@@ -0,0 +1,15 @@
+# Top-most EditorConfig file.
+root = true
+
+# Default settings for all files.
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+# Python files.
+[*.py]
+indent_size = 4

mldebug-0.0.1/.envrc

@@ -0,0 +1,67 @@
+# =========================
+# Tool versions (pinned)
+# =========================
+PYTHON_VERSION=3.10.20
+UV_VERSION=0.11.7
+
+# =========================
+# Load environment files
+# =========================
+if [ -f .env ]; then
+  set -o allexport
+  source .env
+  set +o allexport
+fi
+
+if [ -f .env.local ]; then
+  set -o allexport
+  source .env.local
+  set +o allexport
+fi
+
+# =========================
+# Install uv (pinned)
+# =========================
+UV_BIN="$PWD/.local/bin/uv"
+
+if [ ! -x "$UV_BIN" ] || ! "$UV_BIN" --version | grep -q "$UV_VERSION"; then
+  curl --proto '=https' --tlsv1.2 -LsSf \
+    https://github.com/astral-sh/uv/releases/download/$UV_VERSION/uv-installer.sh \
+    | UV_UNMANAGED_INSTALL="$PWD/.local/bin" sh
+fi
+
+export PATH="$PWD/.local/bin:$PATH"
+
+# =========================
+# Ensure uv.lock exists
+# =========================
+if [ ! -f uv.lock ]; then
+  uv lock
+fi
+
+# =========================
+# Create / validate venv
+# =========================
+VENV_PYTHON=""
+if [ -x ".venv/bin/python" ]; then
+  VENV_PYTHON=$(.venv/bin/python -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}')")
+fi
+
+if [ ! -d .venv ] || [ "$VENV_PYTHON" != "$PYTHON_VERSION" ]; then
+  uv venv --python "$PYTHON_VERSION"
+fi
+
+# =========================
+# Activate venv
+# =========================
+if [ -f .venv/bin/activate ]; then
+  set -o allexport
+  source .venv/bin/activate
+  set +o allexport
+  unset PS1
+fi
+
+# =========================
+# Sync dependencies
+# =========================
+uv sync --frozen

mldebug-0.0.1/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

mldebug-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,99 @@
+name: CI
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*"
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Run linting
+        run: |
+          source .envrc
+          poe lint-ci-all
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Run tests
+        run: |
+          source .envrc
+          poe test-all
+      - name: Upload coverage
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+
+  build:
+    needs: [lint, test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Build package and docs
+        run: |
+          source .envrc
+          pdoc src/* -d numpy -o ./docs --no-show-source
+          uv sync --no-dev --frozen
+          uv build --out-dir ./dist
+      - name: Upload package artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+      - name: Upload docs artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: docs
+          path: docs/
+
+  deploy-docs:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Download docs artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: docs
+          path: docs/
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v6
+      - name: Download package artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

mldebug-0.0.1/.gitignore

@@ -0,0 +1,78 @@
+# =========================
+# Python virtual environments
+# =========================
+.venv/
+venv/
+env/
+
+# =========================
+# Bytecode / caches
+# =========================
+**/*.pyc
+__pycache__/
+*.pyo
+*.pyd
+
+# =========================
+# IDEs
+# =========================
+.idea/
+!.idea/runConfigurations/
+.vscode/
+
+# =========================
+# Jupyter
+# =========================
+.ipynb_checkpoints/
+
+# =========================
+# Ruff / lint caches
+# =========================
+.ruff_cache/
+.mypy_cache/
+.pyright/
+.pytype/
+
+# =========================
+# Build artifacts
+# =========================
+build/
+dist/
+.eggs/
+*.egg-info/
+*.egg
+
+# =========================
+# Testing / coverage
+# =========================
+.pytest_cache/
+.coverage*
+coverage.xml
+htmlcov/
+
+# =========================
+# Documentation builds
+# =========================
+docs/
+site/
+
+# =========================
+# Environment files
+# =========================
+.env
+.env.*
+!.env.example
+!.envrc
+
+# =========================
+# Local tooling / system files
+# =========================
+.local/
+.tox/
+.mypy_cache/
+
+# =========================
+# OS junk
+# =========================
+.DS_Store
+Thumbs.db

mldebug-0.0.1/LICENSE

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

mldebug-0.0.1/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: mldebug
+Version: 0.0.1
+Summary: mldebug is a lightweight Python toolkit for debugging machine learning systems in production.
+Project-URL: Homepage, https://github.com/anpenta/mldebug
+Project-URL: Repository, https://github.com/anpenta/mldebug
+Project-URL: Documentation, https://anpenta.github.io/mldebug
+Project-URL: Issues, https://github.com/anpenta/mldebug/issues
+Author-email: Andreas Pentaliotis <40018182+anpenta@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: debugging,machine-learning,ml,monitoring,production
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# mldebug
+
+[![CI](https://github.com/anpenta/mldebug/actions/workflows/ci.yml/badge.svg)](https://github.com/anpenta/mldebug/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/anpenta/mldebug/graph/badge.svg?token=XPN447G4S9)](https://codecov.io/gh/anpenta/mldebug)
+
+mldebug is a lightweight Python toolkit for debugging machine learning systems in production.
+
+## Quick Start
+
+```bash
+git clone https://github.com/anpenta/mldebug
+cd mldebug
+direnv allow
+poe test
+```
+
+## Status
+
+Active development (v0.x, not yet stable).
+
+## Features
+
+- Debug ML systems in production environments
+- Lightweight diagnostic utilities
+- Designed for integration into modern ML pipelines
+- Focus on observability and failure analysis
+
+## Installation
+
+```bash
+pip install mldebug
+```
+
+## Example Usage
+
+See [tests/test_public_api.py](tests/test_public_api.py) for real usage examples.
+
+## Documentation
+
+See [github pages](https://anpenta.github.io/mldebug).
+
+## Development Setup
+
+### Requirements
+
+- [Ubuntu 24.04.4](https://releases.ubuntu.com/noble/) (recommended) or [WSL](https://ubuntu.com/desktop/wsl)
+- [Git](https://git-scm.com/)
+- [direnv](https://direnv.net/)
+
+### Environment Setup
+
+If not already done via [Quick Start](#quick-start):
+
+```bash
+direnv allow
+```
+
+## Development Workflow
+
+Tasks are managed via [poe](https://poethepoet.natn.io/index.html) (available in the project environment via direnv).
+
+### Run tests
+
+```bash
+poe test
+```
+
+### Run linting
+
+```bash
+poe lint
+```
+
+### Run full CI parity checks
+
+```bash
+poe test-all
+poe lint-ci-all
+```
+
+### CI/CD
+
+CI runs multi-Python version testing and linting. All pull requests must pass the checks. Merging is blocked unless all checks pass.
+
+See [.github/workflows/ci.yml](.github/workflows/ci.yml) for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Ensure all CI checks pass
+5. Open a pull request
+
+## Dependency Management
+
+Dependencies are [managed using uv](https://docs.astral.sh/uv/concepts/projects/dependencies/) and defined in [pyproject.toml](pyproject.toml).
+
+## License
+
+See [LICENSE](LICENSE).

mldebug-0.0.1/README.md

@@ -0,0 +1,101 @@
+# mldebug
+
+[![CI](https://github.com/anpenta/mldebug/actions/workflows/ci.yml/badge.svg)](https://github.com/anpenta/mldebug/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/anpenta/mldebug/graph/badge.svg?token=XPN447G4S9)](https://codecov.io/gh/anpenta/mldebug)
+
+mldebug is a lightweight Python toolkit for debugging machine learning systems in production.
+
+## Quick Start
+
+```bash
+git clone https://github.com/anpenta/mldebug
+cd mldebug
+direnv allow
+poe test
+```
+
+## Status
+
+Active development (v0.x, not yet stable).
+
+## Features
+
+- Debug ML systems in production environments
+- Lightweight diagnostic utilities
+- Designed for integration into modern ML pipelines
+- Focus on observability and failure analysis
+
+## Installation
+
+```bash
+pip install mldebug
+```
+
+## Example Usage
+
+See [tests/test_public_api.py](tests/test_public_api.py) for real usage examples.
+
+## Documentation
+
+See [github pages](https://anpenta.github.io/mldebug).
+
+## Development Setup
+
+### Requirements
+
+- [Ubuntu 24.04.4](https://releases.ubuntu.com/noble/) (recommended) or [WSL](https://ubuntu.com/desktop/wsl)
+- [Git](https://git-scm.com/)
+- [direnv](https://direnv.net/)
+
+### Environment Setup
+
+If not already done via [Quick Start](#quick-start):
+
+```bash
+direnv allow
+```
+
+## Development Workflow
+
+Tasks are managed via [poe](https://poethepoet.natn.io/index.html) (available in the project environment via direnv).
+
+### Run tests
+
+```bash
+poe test
+```
+
+### Run linting
+
+```bash
+poe lint
+```
+
+### Run full CI parity checks
+
+```bash
+poe test-all
+poe lint-ci-all
+```
+
+### CI/CD
+
+CI runs multi-Python version testing and linting. All pull requests must pass the checks. Merging is blocked unless all checks pass.
+
+See [.github/workflows/ci.yml](.github/workflows/ci.yml) for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Ensure all CI checks pass
+5. Open a pull request
+
+## Dependency Management
+
+Dependencies are [managed using uv](https://docs.astral.sh/uv/concepts/projects/dependencies/) and defined in [pyproject.toml](pyproject.toml).
+
+## License
+
+See [LICENSE](LICENSE).

mldebug-0.0.1/pyproject.toml

@@ -0,0 +1,123 @@
+[project]
+name = "mldebug"
+description = "mldebug is a lightweight Python toolkit for debugging machine learning systems in production."
+authors = [{name = "Andreas Pentaliotis", email = "40018182+anpenta@users.noreply.github.com"}]
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+keywords = ["machine-learning", "debugging", "production", "ml", "monitoring"]
+dynamic = ["version"]
+
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+
+dependencies = [
+]
+
+[project.urls]
+Homepage = "https://github.com/anpenta/mldebug"
+Repository = "https://github.com/anpenta/mldebug"
+Documentation = "https://anpenta.github.io/mldebug"
+Issues = "https://github.com/anpenta/mldebug/issues"
+
+[dependency-groups]
+dev = [
+  "pyright[nodejs]>=1.1.408",
+  "poethepoet>=0.42.1",
+  "pytest>=9.0.2",
+  "pytest-cov>=7.1.0",
+  "ruff>=0.15.7",
+  "pdoc>=16.0.0",
+  "tox>=4.50.3",
+  "tox-uv-bare>=1.35.1",
+]
+
+[build-system]
+requires = ["hatchling", "uv-dynamic-versioning"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "uv-dynamic-versioning"
+
+[tool.uv-dynamic-versioning]
+fallback-version = "0.0.0" # Used when no git-based version can be resolved.
+
+[tool.poe]
+default_array_item_task_type = "cmd"
+executor.type = "simple"
+
+[tool.poe.tasks]
+
+test = "pytest --cov=mldebug --cov-report=term --cov-report=xml:coverage.xml --durations=0 --durations-min=0.5"
+test-all.sequence = [
+  # We combine the coverage from all environment runs to provide a unified report.
+  "coverage erase",
+  "tox run -- poe test --cov-append"
+]
+
+lint-ci.sequence = [
+  "ruff format --diff",
+  "ruff check --no-fix",
+  "pyright src",
+  "uv lock --check"
+]
+lint-ci.ignore_fail = "return_non_zero" # Ensures all lint checks run even if one fails.
+lint-ci-all = "tox run -- poe lint-ci"
+
+lint = [
+  "ruff format",
+  "ruff check --fix",
+  "pyright src",
+  "uv lock --check"
+]
+
+[tool.tox]
+envlist = ["py310", "py311", "py312", "py313", "py314"]
+requires = ["tox>=4.0"]
+skip_missing_interpreters = false
+
+[tool.tox.env_run_base]
+runner = "uv-venv-lock-runner"
+package = "uv"
+dependency_groups = ["dev"]
+# Allows forwarding commands through tox for reusable task execution.
+commands = [[ { replace = "posargs", extend = true } ]]
+
+[tool.ruff]
+line-length = 120
+lint.select = ["ALL"]
+lint.ignore = [
+  "COM812",
+  "TRY003",
+  "D203",
+  "D211",
+  "D213",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = [
+  "D100",
+  "D103",
+  "D104",
+  "ANN001",
+  "ANN201",
+  "S101",
+]
+
+[tool.pyright]
+typeCheckingMode = "strict"
+reportMissingImports = false

mldebug-0.0.1/src/mldebug/__init__.py

@@ -0,0 +1,11 @@
+"""mldebug: A lightweight Python toolkit for debugging machine learning systems in production.
+
+This module provides the public API for the mldebug package, including utilities for monitoring, diagnosing,
+and troubleshooting ML pipelines in production environments.
+"""
+
+from ._example import run_public_func
+
+__all__ = [
+    "run_public_func",
+]

mldebug-0.0.1/src/mldebug/_example.py

@@ -0,0 +1,12 @@
+"""Example module demonstrating public and private function patterns.
+
+This module shows how public APIs can use private helper functions within the mldebug package.
+"""
+
+
+def run_public_func() -> None:
+    _run_private_func()
+
+
+def _run_private_func() -> None:
+    pass

mldebug-0.0.1/tests/test_example.py

@@ -0,0 +1,5 @@
+from mldebug._example import _run_private_func
+
+
+def test_run_private_func_completes_successfully():
+    _run_private_func()

mldebug-0.0.1/tests/test_public_api.py

@@ -0,0 +1,5 @@
+from mldebug import run_public_func
+
+
+def test_run_public_func_completes_successfully():
+    run_public_func()