b1sl-python 0.1.0__tar.gz → 0.1.1__tar.gz

b1sl_python-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  PYTHON_VERSION: ${{ vars.PYTHON_VERSION || '3.12' }}
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Lint & Test 🧪
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
+      with:
+        enable-cache: true
+
+    - name: Set up Python
+      run: uv python install ${{ env.PYTHON_VERSION }}
+
+    - name: Install dependencies
+      run: uv sync --all-extras --dev
+
+    - name: Run linting (Ruff)
+      run: uv run ruff check .
+
+    - name: Run unit tests (Pytest)
+      run: uv run pytest tests/unit/

b1sl_python-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,49 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+env:
+  PYTHON_VERSION: ${{ vars.PYTHON_VERSION || '3.12' }}
+
+jobs:
+  test:
+    name: Run Unit Tests 🧪
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+      - name: Set up Python
+        run: uv python install ${{ env.PYTHON_VERSION }}
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+      - name: Run unit tests
+        run: uv run pytest tests/unit/
+
+  build-n-publish:
+    name: Build & publish 📦
+    needs: test
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # Required for Trusted Publishing if used
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+      - name: Set up Python
+        run: uv python install ${{ env.PYTHON_VERSION }}
+      - name: Build distribution
+        run: uv build
+      - name: Publish package to PyPI 🐍
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: uv publish

b1sl_python-0.1.1/Makefile

@@ -0,0 +1,74 @@
+# SAP B1 Python SDK - Testing & Development
+
+.PHONY: help test test-vcr test-record test-demo test-ci coverage-html lint clean
+
+# Default variables
+PYTHONPATH := src:.
+PYTEST := .venv/bin/pytest
+VENV := .venv
+
+help:
+	@echo "Available commands:"
+	@echo "  make test             - Run unit tests only (Fast, No network)"
+	@echo "  make test-vcr         - Run integration tests with recorded cassettes (Offline)"
+	@echo "  make test-record      - Record new VCR cassettes against a real SAP server (Requires .env)"
+	@echo "  make test-demo        - Live smoke tests against SAP demo server (APP_ENV=demo)"
+	@echo "  make test-ci          - Full test suite + coverage (for GitHub Actions)"
+	@echo "  make coverage-html    - Run test-ci and open visual HTML gap analysis"
+	@echo "  make lint             - Run static analysis (Ruff + Mypy)"
+	@echo "  make clean            - Remove cache and temporary files"
+
+test:
+	@echo "🚀 Running unit tests (Layer 1)..."
+	PYTHONPATH=$(PYTHONPATH) $(PYTEST) -m "not (integration or vcr)"
+
+test-vcr:
+	@echo "📽️  Running integration tests with VCR cassettes (Layer 2)..."
+	PYTHONPATH=$(PYTHONPATH) $(PYTEST) -m "vcr" --record-mode=none
+
+test-record:
+	@if [ ! -f .env ]; then echo "❌ Error: .env file required for recording."; exit 1; fi
+	@echo "🔴 Recording new cassettes... (Requires connection to SAP)"
+	PYTHONPATH=$(PYTHONPATH) $(PYTEST) -m "vcr" --record-mode=all
+
+test-demo:
+	@if [ ! -f .env ]; then echo "❌ Error: .env file required for demo tests."; exit 1; fi
+	@echo "🏗️  Running live smoke tests against demo server..."
+	APP_ENV=demo PYTHONPATH=$(PYTHONPATH) $(PYTEST) -m "integration"
+
+test-ci:
+	@echo "⛓️ Running full CI suite (Unit + VCR + Coverage)..."
+	PYTHONPATH=$(PYTHONPATH) $(PYTEST) -m "not integration" --cov=src --cov-report=xml --cov-report=term
+
+coverage-html: test-ci
+	@echo "📊 Generating visual coverage report..."
+	.venv/bin/coverage html -d htmlcov/
+	@if [ "$$(uname)" = "Darwin" ]; then open htmlcov/index.html; \
+	 elif [ "$$(expr substr $$(uname -s) 1 5)" = "Linux" ]; then xdg-open htmlcov/index.html; \
+	 else echo "Open htmlcov/index.html manually to see report."; fi
+
+lint:
+	@echo "🧹 Linting code..."
+	$(VENV)/bin/ruff check src tests
+	$(VENV)/bin/mypy src
+
+# Release automation (Pro mode)
+# Usage: make release v=0.1.x
+release: lint test
+	@if [ -z "$(v)" ]; then \
+		echo "❌ Error: Version required. Example: make release v=0.1.2"; \
+		exit 1; \
+	fi
+	@echo "🚀 Preparing release v$(v)..."
+	git add .
+	git commit -m "chore: Release v$(v) - Automated build"
+	git tag -a v$(v) -m "v$(v)"
+	@echo "📤 Pushing to GitHub (Branch main + Tags)..."
+	git push origin main --tags
+	@echo "✅ Done! GitHub Actions will handle the PyPI publication."
+
+clean:
+	@echo "🧹 Cleaning temporary files..."
+	rm -rf .pytest_cache .mypy_cache .coverage htmlcov .ruff_cache coverage.xml
+	find . -type d -name "__pycache__" -exec rm -rf {} +
+	find . -type f -name "*.pyc" -delete

b1sl_python-0.1.1/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: b1sl-python
+Version: 0.1.1
+Summary: A framework-agnostic Python SDK for SAP Business One Service Layer and SAP HANA. (Unofficial)
+Project-URL: Homepage, https://github.com/operator-ita/b1sl-python
+Project-URL: Repository, https://github.com/operator-ita/b1sl-python
+Project-URL: Bug Tracker, https://github.com/operator-ita/b1sl-python/issues
+Project-URL: Documentation, https://github.com/operator-ita/b1sl-python/tree/main/docs
+Author: Eliceo Guzman
+License: MIT
+License-File: LICENSE
+Keywords: erp,hana,odata,sap,sap-b1,service-layer
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: <3.13,>=3.11
+Requires-Dist: httpx<1,>=0.28.1
+Requires-Dist: pydantic<3,>=2.0.0
+Requires-Dist: python-dotenv>=1.2.2
+Provides-Extra: all
+Requires-Dist: beautifulsoup4>=4.14.3; extra == 'all'
+Requires-Dist: django<6,>=4.2; extra == 'all'
+Requires-Dist: hdbcli<3,>=2.20.0; extra == 'all'
+Requires-Dist: lxml>=6.0.2; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1.3.0; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-django; extra == 'dev'
+Requires-Dist: pytest-recording>=0.13.4; extra == 'dev'
+Requires-Dist: pytest<9.0,>=8.0; extra == 'dev'
+Requires-Dist: python-dotenv>=1.2.2; extra == 'dev'
+Requires-Dist: responses>=0.26.0; extra == 'dev'
+Requires-Dist: respx>=0.22.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: django
+Requires-Dist: django<6,>=4.2; extra == 'django'
+Provides-Extra: generator
+Requires-Dist: beautifulsoup4>=4.14.3; extra == 'generator'
+Requires-Dist: lxml>=6.0.2; extra == 'generator'
+Provides-Extra: hana
+Requires-Dist: hdbcli<3,>=2.20.0; extra == 'hana'
+Description-Content-Type: text/markdown
+
+# b1sl-python
+### Modern, async-first Python SDK for SAP Business One Service Layer.
+
+![b1sl Banner](https://raw.githubusercontent.com/operator-ita/b1sl-python/refs/heads/main/docs/assets/hero_banner.png)
+
+[![Python Version](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Pydantic v2](https://img.shields.io/badge/Pydantic-v2-orange.svg)](https://docs.pydantic.dev/)
+[![Built with httpx](https://img.shields.io/badge/HTTP-httpx-blueviolet.svg)](https://www.python-httpx.org/)
+
+b1sl is a high-performance SDK designed for the SAP B1 Service Layer, focusing on concurrency, type safety, and efficient session management.
+
+---
+
+## Key Features
+
+*   **Async-First Architecture**: Built on top of `httpx` for non-blocking I/O.
+*   **Type Safety**: Full Pydantic v2 integration for all SAP entities.
+*   **Smart Session Management**: Automatic 401 re-authentication with internal locking to prevent license exhaustion.
+*   **Session Hydration**: Reuse existing `B1SESSION` IDs across serverless functions or Temporal activities.
+*   **Optimistic Concurrency**: Automated ETag handling with smart cache invalidation on 412 conflicts.
+*   **Observability**: Structured logging and event hooks for performance monitoring.
+
+---
+
+## Installation
+
+```bash
+# Using pip
+pip install b1sl-python
+
+# Using uv
+uv add b1sl-python
+```
+
+---
+
+## Quick Start
+
+```python
+import asyncio
+from b1sl.b1sl import AsyncB1Client, B1Config
+
+async def main():
+    config = B1Config.from_env() 
+    
+    async with AsyncB1Client(config) as b1:
+        # Full type hints for items and major entities
+        item = await b1.items.get("C1000")
+        print(f"Item: {item.ItemName}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+---
+
+## Advanced Usage: FastAPI Integration
+
+b1sl is optimized for modern web frameworks. We recommend using the Lifespan pattern to share a single connection pool:
+
+```python
+from fastapi import FastAPI
+from contextlib import asynccontextmanager
+from b1sl.b1sl import AsyncB1Client, B1Config
+
+b1_client = None
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    global b1_client
+    config = B1Config.from_env()
+    b1_client = AsyncB1Client(config)
+    await b1_client.connect()
+    yield
+    await b1_client.aclose()
+
+app = FastAPI(lifespan=lifespan)
+
+@app.get("/items/{item_code}")
+async def get_item(item_code: str):
+    return await b1_client.items.get(item_code)
+```
+
+---
+
+## Architecture Overview
+
+| Feature | Implementation | Benefit |
+| :--- | :--- | :--- |
+| **HTTP Engine** | `httpx` (Async/Sync) | Superior performance & timeouts |
+| **Data Models** | `Pydantic v2` | Instant validation & IDE autocomplete |
+| **Auth** | Auto-retry 401 & Hydration | Zero-downtime session management |
+| **Concurrency** | Shared Connection Pool | Prevents SAP License Exhaustion |
+
+---
+
+## Why b1sl?
+
+In production environments, SAP Business One Service Layer is sensitive to session limits and licensing costs. Traditional wrappers often create redundant connections, leading to overhead and frequent auth failures. 
+
+**b1sl** addresses these issues through:
+1. **Session Persistence**: Maintaining long-lived sessions and performing atomic re-authentication.
+2. **Resource Efficiency**: Validated Pydantic models reduce runtime exceptions and memory footprint.
+3. **Concurrency Control**: Internal locking ensures that concurrent requests wait for a single login attempt instead of triggering multiple auth calls.
+
+---
+
+## SAP Compatibility
+
+This SDK is optimized for modern Service Layer environments and defaults to **v2 (OData V4)**.
+
+*   **Verified Baseline**: Service Layer **1.27** (SAP 10.0 FP 2405).
+*   **Minimum for ETags**: Requires Service Layer **1.21+** (March 2021).
+*   **Backward Compatibility**: Supports **v1 (OData V2)** through client configuration.
+
+For a detailed history of Service Layer features and specific version support, see the [Full Compatibility Timeline](https://github.com/operator-ita/b1sl-python/blob/main/docs/02-compatibility.md).
+
+---
+
+## Contributing
+
+Contributions are welcome. Please open an issue to discuss proposed changes before submitting a pull request.
+
+---
+
+## License
+
+MIT © 2026.

b1sl_python-0.1.1/README.md

@@ -0,0 +1,129 @@
+# b1sl-python
+### Modern, async-first Python SDK for SAP Business One Service Layer.
+
+![b1sl Banner](https://raw.githubusercontent.com/operator-ita/b1sl-python/refs/heads/main/docs/assets/hero_banner.png)
+
+[![Python Version](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![Pydantic v2](https://img.shields.io/badge/Pydantic-v2-orange.svg)](https://docs.pydantic.dev/)
+[![Built with httpx](https://img.shields.io/badge/HTTP-httpx-blueviolet.svg)](https://www.python-httpx.org/)
+
+b1sl is a high-performance SDK designed for the SAP B1 Service Layer, focusing on concurrency, type safety, and efficient session management.
+
+---
+
+## Key Features
+
+*   **Async-First Architecture**: Built on top of `httpx` for non-blocking I/O.
+*   **Type Safety**: Full Pydantic v2 integration for all SAP entities.
+*   **Smart Session Management**: Automatic 401 re-authentication with internal locking to prevent license exhaustion.
+*   **Session Hydration**: Reuse existing `B1SESSION` IDs across serverless functions or Temporal activities.
+*   **Optimistic Concurrency**: Automated ETag handling with smart cache invalidation on 412 conflicts.
+*   **Observability**: Structured logging and event hooks for performance monitoring.
+
+---
+
+## Installation
+
+```bash
+# Using pip
+pip install b1sl-python
+
+# Using uv
+uv add b1sl-python
+```
+
+---
+
+## Quick Start
+
+```python
+import asyncio
+from b1sl.b1sl import AsyncB1Client, B1Config
+
+async def main():
+    config = B1Config.from_env() 
+    
+    async with AsyncB1Client(config) as b1:
+        # Full type hints for items and major entities
+        item = await b1.items.get("C1000")
+        print(f"Item: {item.ItemName}")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+---
+
+## Advanced Usage: FastAPI Integration
+
+b1sl is optimized for modern web frameworks. We recommend using the Lifespan pattern to share a single connection pool:
+
+```python
+from fastapi import FastAPI
+from contextlib import asynccontextmanager
+from b1sl.b1sl import AsyncB1Client, B1Config
+
+b1_client = None
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    global b1_client
+    config = B1Config.from_env()
+    b1_client = AsyncB1Client(config)
+    await b1_client.connect()
+    yield
+    await b1_client.aclose()
+
+app = FastAPI(lifespan=lifespan)
+
+@app.get("/items/{item_code}")
+async def get_item(item_code: str):
+    return await b1_client.items.get(item_code)
+```
+
+---
+
+## Architecture Overview
+
+| Feature | Implementation | Benefit |
+| :--- | :--- | :--- |
+| **HTTP Engine** | `httpx` (Async/Sync) | Superior performance & timeouts |
+| **Data Models** | `Pydantic v2` | Instant validation & IDE autocomplete |
+| **Auth** | Auto-retry 401 & Hydration | Zero-downtime session management |
+| **Concurrency** | Shared Connection Pool | Prevents SAP License Exhaustion |
+
+---
+
+## Why b1sl?
+
+In production environments, SAP Business One Service Layer is sensitive to session limits and licensing costs. Traditional wrappers often create redundant connections, leading to overhead and frequent auth failures. 
+
+**b1sl** addresses these issues through:
+1. **Session Persistence**: Maintaining long-lived sessions and performing atomic re-authentication.
+2. **Resource Efficiency**: Validated Pydantic models reduce runtime exceptions and memory footprint.
+3. **Concurrency Control**: Internal locking ensures that concurrent requests wait for a single login attempt instead of triggering multiple auth calls.
+
+---
+
+## SAP Compatibility
+
+This SDK is optimized for modern Service Layer environments and defaults to **v2 (OData V4)**.
+
+*   **Verified Baseline**: Service Layer **1.27** (SAP 10.0 FP 2405).
+*   **Minimum for ETags**: Requires Service Layer **1.21+** (March 2021).
+*   **Backward Compatibility**: Supports **v1 (OData V2)** through client configuration.
+
+For a detailed history of Service Layer features and specific version support, see the [Full Compatibility Timeline](https://github.com/operator-ita/b1sl-python/blob/main/docs/02-compatibility.md).
+
+---
+
+## Contributing
+
+Contributions are welcome. Please open an issue to discuss proposed changes before submitting a pull request.
+
+---
+
+## License
+
+MIT © 2026.

b1sl_python-0.1.1/pyproject.toml

@@ -0,0 +1,117 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "b1sl-python"
+version = "0.1.1"
+description = "A framework-agnostic Python SDK for SAP Business One Service Layer and SAP HANA. (Unofficial)"
+readme = "README.md"
+requires-python = ">=3.11,<3.13"
+license = { text = "MIT" }
+keywords = ["sap", "sap-b1", "service-layer", "hana", "erp", "odata"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+
+    "Typing :: Typed",
+]
+authors = [
+    { name = "Eliceo Guzman" },
+]
+
+# ── Core: minimal footprint ─────────────────────────────────────────────── #
+dependencies = [
+    "pydantic>=2.0.0,<3",
+    "httpx>=0.28.1,<1",
+    "python-dotenv>=1.2.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/operator-ita/b1sl-python"
+Repository = "https://github.com/operator-ita/b1sl-python"
+"Bug Tracker" = "https://github.com/operator-ita/b1sl-python/issues"
+Documentation = "https://github.com/operator-ita/b1sl-python/tree/main/docs"
+
+[project.optional-dependencies]
+hana = ["hdbcli>=2.20.0,<3"]
+django = ["django>=4.2,<6"]
+generator = [
+    "beautifulsoup4>=4.14.3",
+    "lxml>=6.0.2",
+]
+dev = [
+    "pytest>=8.0,<9.0",
+    "pytest-django",
+    "pytest-asyncio>=1.3.0",
+    "pytest-recording>=0.13.4",
+    "python-dotenv>=1.2.2",
+    "respx>=0.22.0",
+    "responses>=0.26.0",
+    "ruff",
+    "mypy",
+
+    "pytest-cov",
+]
+
+all = ["b1sl-python[hana,django,generator]"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/b1sl"]
+exclude = [
+    "/scripts",
+    "/metadata",
+    "/examples",
+    "/docs",
+]
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "/scripts",
+    "/metadata",
+    "/examples",
+    "/docs",
+    "/.env",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+markers = [
+    "integration: tests that require a real SAP B1 Service Layer connection",
+    "vcr: tests that use pytest-recording to capture HTTP traffic",
+]
+addopts = "--tb=short --cov=src --cov-report=term-missing"
+
+[tool.mypy]
+files = ["src"]
+strict = true
+ignore_missing_imports = true
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+extend-exclude = [
+    "src/b1sl/b1sl/models/_generated",
+    "src/b1sl/b1sl/resources/_generated",
+    "scripts",
+]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I"]
+ignore = ["E501", "W291", "W293"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ruff.lint.extend-per-file-ignores]
+"src/b1sl/b1sl/entities/__init__.py" = ["F401", "F403", "F405"]
+"examples/**" = ["E402", "F841"]
+
+[tool.pyright]
+include = ["src", "scripts"]
+extraPaths = [".", "scripts"]

b1sl_python-0.1.1/src/b1sl/b1sl/__init__.py

@@ -0,0 +1,56 @@
+"""
+b1sl.b1sl — SDK for SAP B1 Service Layer (OData).
+"""
+
+import logging
+import warnings
+
+from b1sl.b1sl.async_client import AsyncB1Client
+from b1sl.b1sl.async_rest_adapter import AsyncRestAdapter
+from b1sl.b1sl.base_adapter import HookContext, ObservabilityConfig
+from b1sl.b1sl.client import B1Client
+from b1sl.b1sl.config import B1Config
+from b1sl.b1sl.config_manager import B1Environment
+from b1sl.b1sl.environment import B1Env
+from b1sl.b1sl.exceptions.exceptions import SAPConcurrencyError
+from b1sl.b1sl.resources.async_base import AsyncGenericResource
+from b1sl.b1sl.resources.base import GenericResource, ODataQuery
+from b1sl.b1sl.rest_adapter import RestAdapter
+
+try:
+    from pydantic import ArbitraryTypeWarning
+
+    warnings.filterwarnings("ignore", category=ArbitraryTypeWarning, module=r"b1sl\..*")
+except ImportError:
+    warnings.filterwarnings("ignore", module=r"b1sl\..*|pydantic\..*")
+
+# Standard library pattern: prevent "No handlers could be found"
+logging.getLogger("b1sl").addHandler(logging.NullHandler())
+
+try:
+    from b1sl.b1sl import entities
+except ImportError:
+    entities = None  # Before code generation
+
+try:
+    from b1sl.b1sl import fields
+except ImportError:
+    fields = None
+
+__all__ = [
+    "AsyncB1Client",
+    "B1Client",
+    "B1Config",
+    "B1Environment",
+    "AsyncRestAdapter",
+    "RestAdapter",
+    "B1Env",
+    "SAPConcurrencyError",
+    "AsyncGenericResource",
+    "GenericResource",
+    "ODataQuery",
+    "entities",
+    "fields",
+    "HookContext",
+    "ObservabilityConfig",
+]