whitebox-xai-sdk 1.0.0__tar.gz

whitebox_xai_sdk-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,72 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - 'README.md'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - 'README.md'
+  workflow_dispatch:
+
+jobs:
+  validate-docs:
+    name: Validate Documentation
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+
+    - name: Install markdown linter
+      run: |
+        npm install -g markdownlint-cli
+
+    - name: Lint markdown files
+      run: |
+        markdownlint '**/*.md' --ignore node_modules --ignore .github || true
+
+    - name: Check for broken links
+      uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-quiet-mode: 'yes'
+        config-file: '.github/markdown-link-check-config.json'
+      continue-on-error: true
+
+  build-docs:
+    name: Build Documentation
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+        pip install mkdocs mkdocs-material mkdocstrings[python]
+
+    - name: Build documentation
+      run: |
+        mkdocs build --strict
+
+    - name: Upload documentation
+      uses: actions/upload-artifact@v4
+      with:
+        name: documentation
+        path: site/

whitebox_xai_sdk-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,47 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build-and-publish:
+    name: Build and publish Python distribution
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for OIDC trusted publishing
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.9'
+
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build distribution
+      run: |
+        python -m build
+
+    - name: Check distribution
+      run: |
+        pip install twine
+        twine check dist/*
+
+    - name: Publish to PyPI
+      if: github.event_name == 'release'
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/

whitebox_xai_sdk-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,143 @@
+name: Test
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+  workflow_dispatch:
+
+env:
+  PYTHON_VERSION: '3.9'
+
+jobs:
+  code-quality:
+    name: Code Quality Checks
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+        cache: 'pip'
+
+    - name: Install code quality tools
+      run: |
+        python -m pip install --upgrade pip
+        pip install black==23.11.0 isort==5.12.0 flake8==6.1.0 pylint==3.0.3 mypy==1.7.1 bandit==1.7.5
+
+    - name: Run Black formatter check
+      run: |
+        black --check --diff .
+
+    - name: Run isort import check
+      run: |
+        isort --check-only --diff .
+
+    - name: Run flake8 linter
+      run: |
+        flake8 whiteboxxai/ tests/ examples/ --count --statistics --max-line-length=120
+
+    - name: Run pylint
+      run: |
+        pylint whiteboxxai/ --exit-zero --score=yes
+
+    - name: Run security check (Bandit)
+      run: |
+        bandit -r whiteboxxai/ -f json -o bandit-report.json || true
+
+    - name: Upload Bandit report
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: bandit-security-report
+        path: bandit-report.json
+
+  unit-tests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev]"
+
+    - name: Run unit tests
+      run: |
+        pytest tests/unit -v --cov=whiteboxxai --cov-report=xml
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      if: matrix.python-version == '3.9'
+      with:
+        file: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+
+  integration-tests:
+    name: Integration Tests
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev,all]"
+
+    - name: Run integration tests
+      run: |
+        pytest tests/integration -v
+
+  e2e-tests:
+    name: End-to-End Tests
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[dev,all]"
+
+    - name: Run e2e tests
+      run: |
+        pytest tests/e2e -v || EXIT=$?
+        if [ "${EXIT:-0}" -eq 5 ]; then
+          echo "No e2e tests collected - skipping"
+          exit 0
+        fi
+        exit "${EXIT:-0}"

whitebox_xai_sdk-1.0.0/.gitignore

@@ -0,0 +1,210 @@
+# 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/
+
+# 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__/
+
+# Internal migration notes
+MIGRATION_SUMMARY.md

whitebox_xai_sdk-1.0.0/CHANGELOG.md

@@ -0,0 +1,158 @@
+# Changelog
+
+All notable changes to the WhiteBoxXAI Python SDK will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2026-07-14
+
+First stable, production release. This release realigns the SDK with the
+`whiteboxxai.com` product branding and folds in the fixes/features
+developed in the `whitebox-xai-azure` monorepo's `sdk/` directory.
+
+### Changed
+- **BREAKING**: Rebranded from `whiteboxai`/`whiteboxai-sdk` (single "x",
+  `whiteboxai.io`/`whitebox.agentaflow.com`) to `whiteboxxai`/`whitebox-xai-sdk`
+  (double "x", `whiteboxxai.com`). Update imports: `from whiteboxai import ...`
+  → `from whiteboxxai import ...`; update the install command to
+  `pip install whitebox-xai-sdk`; update the `EXPLAINAI_*` env vars to
+  `WHITEBOXXAI_*` (`WHITEBOXXAI_API_KEY`, `WHITEBOXXAI_BASE_URL`).
+- **BREAKING**: Switched from a `src/whiteboxai/` layout to a flat
+  `whiteboxxai/` layout at the repository root, matching the canonical
+  source in `whitebox-xai-azure/sdk/`. Removed the legacy `setup.py`;
+  `pyproject.toml` is now the single build configuration.
+- Version is now read from installed package metadata
+  (`importlib.metadata.version("whitebox-xai-sdk")`) instead of being
+  hardcoded in three separate places.
+- `Development Status` classifier bumped from Beta to Production/Stable.
+- `ModelMonitor.log_prediction()`/`alog_prediction()`/`log_batch()` now call
+  the predictions API with the correct `input_data`/`output_data` field
+  names (previously sent `inputs`/`outputs`, which the real API doesn't
+  accept).
+
+### Added
+- `ModelMonitor` local buffering (`buffer_size=`) with `flush()`/`aflush()`
+  and context-manager support (`with ModelMonitor(...) as monitor:`
+  flushes on exit).
+- `ModelMonitor.get_prediction_count()`, `get_drift_reports()`,
+  `create_alert_rule()`, and `get_active_alerts()` convenience methods.
+- `log_prediction(explain=True)` now actually triggers explanation
+  generation via the explanations resource, instead of silently
+  accepting and dropping the flag.
+- SDK exception classes (`APIError`, `AuthenticationError`, `RateLimitError`,
+  `ValidationError`, `NotFoundError`) now carry structured metadata
+  (`status_code`, `response`, `request_id`, `retry_after`, `fields`, etc.)
+  instead of being bare, attribute-less `Exception` subclasses.
+- `Config` now validates `timeout`/`max_retries` are positive.
+- MCP (Model Context Protocol) usage documented in `README.md` for
+  non-Python integrations, pointing at the companion `whiteboxxai-mcp`
+  package.
+- `LICENSE` file (MIT), matching `pyproject.toml`'s declared license.
+
+### Fixed
+- Fixed an import-time crash: `whiteboxxai.integrations` (and therefore the
+  whole SDK) failed to import for anyone without PyTorch or TensorFlow
+  installed, due to bad optional-dependency fallback stubs in
+  `integrations/pytorch.py` and `integrations/tensorflow.py`, and an
+  unguarded/unbound name in `integrations/langchain.py`.
+- `README.md` code samples fixed throughout: wrong import path
+  (`whiteboxai` → `whiteboxxai`), wrong class name (`WhiteBoxAI` →
+  `WhiteBoxXAI`), and wrong install command.
+- Corrected `WhiteBoxXAI_*`-cased env var references (wrong case, and in
+  one place the wrong variable name entirely) to the real
+  `WHITEBOXXAI_API_KEY`/`WHITEBOXXAI_BASE_URL` across guides and examples.
+- `docs/` guides (`api-reference.md`, `getting-started.md`, `index.md`,
+  `integrations.md`, `offline-mode.md`) rebranded from the stale
+  `whiteboxai.io`/`agentaflow.com`/`EXPLAINAI_*` naming.
+
+## [0.2.1] - 2026-05-03
+
+No changelog entry was recorded for this release at the time. Reconstructed
+from the git history between the `0.2.0` and `0.2.1` tags:
+
+### Added
+- `AgentWorkflows` resource and client binding for multi-agent workflow
+  tracking.
+
+### Fixed
+- e2e pytest exit-code handling.
+- Import normalization and formatting cleanup across integrations and
+  examples.
+
+## [0.2.0] - 2026-02-10
+
+### Added
+- **Git Integration**: Automatic Git context detection for model versioning
+  - `GitContext` class for repository metadata
+  - `detect_git_context()` function for auto-detection
+  - `validate_git_context()` for validation
+  - Support for both GitPython and subprocess fallback
+- **CrewAI Multi-Agent Monitoring**: Full support for CrewAI workflows
+  - `CrewAIMonitor` class for monitoring crews
+  - Automatic agent and task tracking
+  - Agent-to-agent interaction logging
+  - Token usage and cost tracking
+  - Workflow analytics
+- **LangChain Multi-Agent Support**: Enhanced LangChain integration
+  - `MultiAgentCallbackHandler` for agent execution tracking
+  - `LangGraphMultiAgentMonitor` for LangGraph workflows
+  - Agent-to-agent handoff monitoring
+  - Tool call tracking
+  - `monitor_langchain_agent()` helper function
+- **Documentation**: Complete MkDocs setup with Material theme
+  - Comprehensive navigation structure
+  - API reference integration
+  - Code highlighting and copy buttons
+  - Dark/light mode support
+
+### Changed
+- **BREAKING**: Fixed import paths from `explainai.*` to `whiteboxai.*`
+  - Users must update imports: `from explainai.client` → `from whiteboxai.client`
+- Updated dependencies:
+  - httpx: >=0.24.0 → >=0.25.0
+  - numpy: >=1.24.0 (aligned with latest stable)
+  - Added pandas>=1.3.0 (core dependency)
+  - Added tenacity>=8.0.0 (core dependency)
+- Enhanced optional dependencies:
+  - Added git extra: `pip install whiteboxai-sdk[git]`
+  - Added crewai extra: `pip install whiteboxai-sdk[crewai]`
+  - Updated all extra: includes git, crewai, and all integrations
+
+### Fixed
+- Import errors due to incorrect package naming (explainai vs whiteboxai)
+- Missing MkDocs configuration causing documentation build failures
+- Incomplete integration exports in `whiteboxai.integrations`
+
+### Documentation
+- Created comprehensive MkDocs configuration
+- Added index page with quick start examples
+- Organized documentation with clear navigation
+- Added examples for Git integration, CrewAI, and LangChain agents
+
+## [0.1.0] - 2026-01-05
+
+### Added
+- Initial release of WhiteBoxAI Python SDK
+- Basic monitoring functionality
+- Scikit-learn integration
+- PyTorch integration
+- TensorFlow/Keras integration
+- Hugging Face Transformers integration
+- LangChain integration
+- XGBoost/LightGBM integration
+- Offline mode support
+- Privacy filters
+- Caching support
+- Example code
+- Documentation
+
+### Security
+- PII detection and masking
+- Secure API key handling
+
+[Unreleased]: https://github.com/AgentaFlow/whitebox-python-sdk/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/AgentaFlow/whitebox-python-sdk/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/AgentaFlow/whitebox-python-sdk/releases/tag/v0.1.0

whitebox_xai_sdk-1.0.0/LICENSE

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

whitebox_xai_sdk-1.0.0/MANIFEST.in

@@ -0,0 +1,31 @@
+# Include requirements files in source distribution
+include README.md
+include LICENSE
+include CHANGELOG.md
+
+# Include configuration files
+include pyproject.toml
+include pytest.ini
+include .gitignore
+
+# Include GitHub workflows and documentation
+recursive-include .github *.md *.yml *.yaml
+
+# Include documentation
+recursive-include docs *.md *.rst *.txt
+
+# Include examples
+recursive-include examples *.py
+
+# Include tests
+recursive-include tests *.py
+
+# Include source package data
+recursive-include whiteboxxai *.py
+
+# Exclude compiled files
+global-exclude *.py[cod]
+global-exclude __pycache__
+global-exclude *.so
+global-exclude .DS_Store
+global-exclude *.egg-info