bitfab-py 0.10.0__tar.gz

bitfab_py-0.10.0/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: bitfab-py
+Version: 0.10.0
+Summary: Bitfab client for provider-based API calls with local BAML execution
+Author: Harvest Team
+Requires-Python: >=3.9
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Provides-Extra: baml
+Provides-Extra: openai-tracing
+Requires-Dist: baml-py (>=0.220.0,<0.221.0) ; extra == "baml"
+Requires-Dist: jsonpickle (>=4.0.0,<5.0.0)
+Requires-Dist: openai-agents (>=0.6.3) ; extra == "openai-tracing"
+Requires-Dist: pydantic (>=2.0.0,<3.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
+Description-Content-Type: text/markdown
+
+# Bitfab
+
+Bitfab client for provider-based API calls.
+
+## Monorepo Structure
+
+This package is part of the Harvest monorepo. While the TypeScript/JavaScript packages use a **pnpm workspace** for shared dependencies, this Python package uses Poetry for its dependency management.
+
+**Note:** The pnpm workspace includes:
+
+- `bitfab-web` - Next.js web application
+- `bitfab-typescript-sdk` - TypeScript SDK
+- `bitfab-vscode` - VS Code extension
+- `frontend` - Legacy frontend
+
+From the root directory, you can run TypeScript tests and validation across all packages with `pnpm test` or `pnpm validate`.
+
+## Installation
+
+### Basic Installation
+
+```bash
+pip install bitfab-py
+```
+
+### With OpenAI Tracing Support
+
+If you want to use the OpenAI Agents SDK tracing integration:
+
+```bash
+pip install bitfab-py[openai-tracing]
+```
+
+### Local Development
+
+For local development:
+
+```bash
+cd bitfab-python-sdk
+poetry install --with dev
+```
+
+After installation, you can use developer tasks. For the best experience, add Poetry's venv to your PATH:
+
+```bash
+# Add to your ~/.zshrc or ~/.bashrc
+export PATH="$(poetry env info --path)/bin:$PATH"
+
+# Then you can use 'dev' directly (no ./run or poetry run needed!)
+dev list
+dev test
+```
+
+See [Development Tasks](#development-tasks) below for all available commands.
+
+Or install as an editable package from the parent directory:
+
+```bash
+poetry add --editable ../bitfab-python-sdk
+```
+
+## Usage
+
+### Basic Usage
+
+```python
+from bitfab import Bitfab
+
+client = Bitfab(
+    api_key="sf_your_api_key_here",
+    service_url="https://bitfab.ai",  # Optional, defaults to production
+    env_vars={"OPENAI_API_KEY": "sk-your-openai-key"},  # Optional, for local BAML execution
+)
+
+result = client.call("method_name", arg1="value1", arg2="value2")
+```
+
+### OpenAI Agents SDK Tracing
+
+If you have the `openai-agents` package installed (via `pip install bitfab-py[openai-tracing]`), you can use the tracing processor:
+
+```python
+from bitfab import Bitfab
+from agents import set_trace_processors
+
+bitfab = Bitfab(api_key="sf_your_api_key_here")
+processor = bitfab.get_openai_tracing_processor()
+
+# Register the processor with OpenAI Agents SDK
+set_trace_processors([processor])
+
+# Now all your agent traces will be sent to Bitfab
+```
+
+**Note:** If you try to use `get_openai_tracing_processor()` without installing the `openai-tracing` extra, you'll get a helpful error message telling you to install it.
+
+## Configuration
+
+- `api_key`: **Required** - Your Bitfab API key (generate from your Bitfab dashboard)
+- `service_url`: Optional - The Bitfab service URL (defaults to `https://bitfab.ai`)
+- `env_vars`: Optional - Environment variables for LLM providers (e.g., `{"OPENAI_API_KEY": "..."}`)
+- `enabled`: Optional - Enable/disable tracing (defaults to `True`). When `False`, decorated functions still execute but no spans are sent.
+
+## Development Tasks
+
+This project uses a Python-based developer tasks module (`dev/`) instead of Makefiles for better cross-platform support and more robust CLI capabilities.
+
+### Using Developer Tasks
+
+After running `poetry install --with dev`, you can use developer tasks:
+
+#### Quick Setup (One-time)
+
+```bash
+# Install dependencies (creates the 'dev' script in the venv)
+poetry install --with dev
+
+# Run this script to add to PATH for current session and get command to make it permanent
+./setup-dev-path.sh
+
+# Copy-paste the command it outputs, then reload your shell config:
+source ~/.zshrc  # or ~/.bashrc
+```
+
+The `setup-dev-path.sh` script will:
+
+- Add the venv bin to PATH for your current session
+- Detect your shell (zsh/bash) and output a command you can copy-paste to make it permanent
+- Skip if already configured
+
+#### Using Developer Commands
+
+Once PATH is set up, use commands directly - just like `make <target>`:
+
+```bash
+dev list              # List all available commands
+dev test              # Run tests
+dev test --verbose    # Run tests with verbose output
+dev lint              # Lint code
+dev format            # Format code
+dev build             # Build package
+dev publish patch      # Publish with version bump
+```
+
+**How it works**: When you define `[tool.poetry.scripts]` in `pyproject.toml`, Poetry creates executable scripts in the venv's `bin/` directory. Adding that `bin/` to PATH makes those scripts available as commands.
+
+**Key advantage**: Just like Makefiles, it's super clear - `dev <command>` is as obvious as `make <target>`!
+
+### Module Structure
+
+Each command is in its own file in the `dev/` module:
+
+- `dev/test.py` - Test commands
+- `dev/lint.py` - Linting
+- `dev/build.py` - Building
+- `dev/publish.py` - Publishing
+- etc.
+
+This makes it easy to find and modify individual commands.
+
+## Publishing
+
+This package uses `bump-my-version` for version management. To publish a new version:
+
+```bash
+# Use the dev command
+dev publish patch          # Bump patch (0.3.0 -> 0.3.1)
+dev publish minor          # Bump minor (0.3.0 -> 0.4.0)
+dev publish major          # Bump major (0.3.0 -> 1.0.0)
+dev publish version=1.2.3  # Custom version
+
+# Or just bump version without publishing
+dev bump patch
+dev bump minor
+```
+
+The publish process will:
+
+1. Run all tests
+2. Bump the version in `pyproject.toml`
+3. Commit and tag the changes
+4. Build the package
+5. Prompt for confirmation before publishing to PyPI
+
+**Note:** Publishing requires:
+
+- A clean git working directory (no uncommitted changes)
+- Poetry installed and configured
+- PyPI credentials configured (via `poetry config pypi-token.pypi <token>`)
+

bitfab_py-0.10.0/README.md

@@ -0,0 +1,189 @@
+# Bitfab
+
+Bitfab client for provider-based API calls.
+
+## Monorepo Structure
+
+This package is part of the Harvest monorepo. While the TypeScript/JavaScript packages use a **pnpm workspace** for shared dependencies, this Python package uses Poetry for its dependency management.
+
+**Note:** The pnpm workspace includes:
+
+- `bitfab-web` - Next.js web application
+- `bitfab-typescript-sdk` - TypeScript SDK
+- `bitfab-vscode` - VS Code extension
+- `frontend` - Legacy frontend
+
+From the root directory, you can run TypeScript tests and validation across all packages with `pnpm test` or `pnpm validate`.
+
+## Installation
+
+### Basic Installation
+
+```bash
+pip install bitfab-py
+```
+
+### With OpenAI Tracing Support
+
+If you want to use the OpenAI Agents SDK tracing integration:
+
+```bash
+pip install bitfab-py[openai-tracing]
+```
+
+### Local Development
+
+For local development:
+
+```bash
+cd bitfab-python-sdk
+poetry install --with dev
+```
+
+After installation, you can use developer tasks. For the best experience, add Poetry's venv to your PATH:
+
+```bash
+# Add to your ~/.zshrc or ~/.bashrc
+export PATH="$(poetry env info --path)/bin:$PATH"
+
+# Then you can use 'dev' directly (no ./run or poetry run needed!)
+dev list
+dev test
+```
+
+See [Development Tasks](#development-tasks) below for all available commands.
+
+Or install as an editable package from the parent directory:
+
+```bash
+poetry add --editable ../bitfab-python-sdk
+```
+
+## Usage
+
+### Basic Usage
+
+```python
+from bitfab import Bitfab
+
+client = Bitfab(
+    api_key="sf_your_api_key_here",
+    service_url="https://bitfab.ai",  # Optional, defaults to production
+    env_vars={"OPENAI_API_KEY": "sk-your-openai-key"},  # Optional, for local BAML execution
+)
+
+result = client.call("method_name", arg1="value1", arg2="value2")
+```
+
+### OpenAI Agents SDK Tracing
+
+If you have the `openai-agents` package installed (via `pip install bitfab-py[openai-tracing]`), you can use the tracing processor:
+
+```python
+from bitfab import Bitfab
+from agents import set_trace_processors
+
+bitfab = Bitfab(api_key="sf_your_api_key_here")
+processor = bitfab.get_openai_tracing_processor()
+
+# Register the processor with OpenAI Agents SDK
+set_trace_processors([processor])
+
+# Now all your agent traces will be sent to Bitfab
+```
+
+**Note:** If you try to use `get_openai_tracing_processor()` without installing the `openai-tracing` extra, you'll get a helpful error message telling you to install it.
+
+## Configuration
+
+- `api_key`: **Required** - Your Bitfab API key (generate from your Bitfab dashboard)
+- `service_url`: Optional - The Bitfab service URL (defaults to `https://bitfab.ai`)
+- `env_vars`: Optional - Environment variables for LLM providers (e.g., `{"OPENAI_API_KEY": "..."}`)
+- `enabled`: Optional - Enable/disable tracing (defaults to `True`). When `False`, decorated functions still execute but no spans are sent.
+
+## Development Tasks
+
+This project uses a Python-based developer tasks module (`dev/`) instead of Makefiles for better cross-platform support and more robust CLI capabilities.
+
+### Using Developer Tasks
+
+After running `poetry install --with dev`, you can use developer tasks:
+
+#### Quick Setup (One-time)
+
+```bash
+# Install dependencies (creates the 'dev' script in the venv)
+poetry install --with dev
+
+# Run this script to add to PATH for current session and get command to make it permanent
+./setup-dev-path.sh
+
+# Copy-paste the command it outputs, then reload your shell config:
+source ~/.zshrc  # or ~/.bashrc
+```
+
+The `setup-dev-path.sh` script will:
+
+- Add the venv bin to PATH for your current session
+- Detect your shell (zsh/bash) and output a command you can copy-paste to make it permanent
+- Skip if already configured
+
+#### Using Developer Commands
+
+Once PATH is set up, use commands directly - just like `make <target>`:
+
+```bash
+dev list              # List all available commands
+dev test              # Run tests
+dev test --verbose    # Run tests with verbose output
+dev lint              # Lint code
+dev format            # Format code
+dev build             # Build package
+dev publish patch      # Publish with version bump
+```
+
+**How it works**: When you define `[tool.poetry.scripts]` in `pyproject.toml`, Poetry creates executable scripts in the venv's `bin/` directory. Adding that `bin/` to PATH makes those scripts available as commands.
+
+**Key advantage**: Just like Makefiles, it's super clear - `dev <command>` is as obvious as `make <target>`!
+
+### Module Structure
+
+Each command is in its own file in the `dev/` module:
+
+- `dev/test.py` - Test commands
+- `dev/lint.py` - Linting
+- `dev/build.py` - Building
+- `dev/publish.py` - Publishing
+- etc.
+
+This makes it easy to find and modify individual commands.
+
+## Publishing
+
+This package uses `bump-my-version` for version management. To publish a new version:
+
+```bash
+# Use the dev command
+dev publish patch          # Bump patch (0.3.0 -> 0.3.1)
+dev publish minor          # Bump minor (0.3.0 -> 0.4.0)
+dev publish major          # Bump major (0.3.0 -> 1.0.0)
+dev publish version=1.2.3  # Custom version
+
+# Or just bump version without publishing
+dev bump patch
+dev bump minor
+```
+
+The publish process will:
+
+1. Run all tests
+2. Bump the version in `pyproject.toml`
+3. Commit and tag the changes
+4. Build the package
+5. Prompt for confirmation before publishing to PyPI
+
+**Note:** Publishing requires:
+
+- A clean git working directory (no uncommitted changes)
+- Poetry installed and configured
+- PyPI credentials configured (via `poetry config pypi-token.pypi <token>`)

bitfab_py-0.10.0/bitfab/__init__.py

@@ -0,0 +1,50 @@
+"""Bitfab client for provider-based API calls."""
+
+from bitfab.client import (
+    AllowedEnvVars,
+    Bitfab,
+    BitfabFunction,
+    CurrentSpan,
+    CurrentTrace,
+    SpanType,
+    flush_traces,
+    get_current_span,
+    get_current_trace,
+)
+from bitfab.replay import ReplayItem, ReplayResult
+
+# Only export BitfabTracingProcessor if openai-agents is available
+try:
+    from bitfab.tracing import (
+        BitfabOpenAITracingProcessor as BitfabTracingProcessor,
+    )
+
+    __all__ = [
+        "AllowedEnvVars",
+        "Bitfab",
+        "BitfabFunction",
+        "BitfabTracingProcessor",
+        "CurrentSpan",
+        "CurrentTrace",
+        "ReplayItem",
+        "ReplayResult",
+        "SpanType",
+        "flush_traces",
+        "get_current_span",
+        "get_current_trace",
+    ]
+except ImportError:
+    # openai-agents not installed, skip tracing processor export
+    __all__ = [
+        "AllowedEnvVars",
+        "Bitfab",
+        "BitfabFunction",
+        "CurrentSpan",
+        "CurrentTrace",
+        "ReplayItem",
+        "ReplayResult",
+        "SpanType",
+        "flush_traces",
+        "get_current_span",
+        "get_current_trace",
+    ]