gaik 0.2.17__tar.gz

gaik-0.2.17/.gitignore

@@ -0,0 +1 @@
+src/gaik/_version.py

gaik-0.2.17/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 GAIK - GenAI for knowledge mgt
+
+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.

gaik-0.2.17/PKG-INFO

@@ -0,0 +1,291 @@
+Metadata-Version: 2.4
+Name: gaik
+Version: 0.2.17
+Summary: General AI Kit - Reusable AI/ML components for Python
+Author: GAIK Project
+License: MIT License
+        
+        Copyright (c) 2025 GAIK - GenAI for knowledge mgt
+        
+        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.
+        
+Project-URL: Homepage, https://gaik.ai/
+Project-URL: Repository, https://github.com/GAIK-project/gaik-toolkit
+Project-URL: Documentation, https://github.com/GAIK-project/gaik-toolkit/tree/main/packages/python/gaik
+Project-URL: Issues, https://github.com/GAIK-project/gaik-toolkit/issues
+Keywords: ai,ml,langchain,openai,anthropic,google,structured-outputs,pydantic,schema,extraction
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.12.4
+Provides-Extra: extract
+Provides-Extra: parser
+Requires-Dist: openai>=2.7; extra == "parser"
+Requires-Dist: PyMuPDF>=1.23.0; extra == "parser"
+Requires-Dist: python-dotenv>=1.0.0; extra == "parser"
+Requires-Dist: docling; extra == "parser"
+Requires-Dist: psutil; extra == "parser"
+Provides-Extra: all
+Requires-Dist: gaik[extract]; extra == "all"
+Requires-Dist: gaik[parser]; extra == "all"
+Provides-Extra: dev
+Requires-Dist: ruff>=0.14.1; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1; extra == "dev"
+Requires-Dist: pytest-mock>=3.12; extra == "dev"
+Requires-Dist: tomli>=2.0.1; extra == "dev"
+Provides-Extra: ci
+Requires-Dist: langchain-core>=1.0.3; extra == "ci"
+Requires-Dist: langchain-openai>=1.0.2; extra == "ci"
+Requires-Dist: langchain-anthropic>=1.0.1; extra == "ci"
+Requires-Dist: langchain-google-genai>=3.0.1; extra == "ci"
+Requires-Dist: ruff>=0.14.1; extra == "ci"
+Requires-Dist: build>=1.0; extra == "ci"
+Requires-Dist: twine>=4.0; extra == "ci"
+Requires-Dist: pytest>=8.0; extra == "ci"
+Requires-Dist: pytest-cov>=4.1; extra == "ci"
+Requires-Dist: pytest-mock>=3.12; extra == "ci"
+Requires-Dist: tomli>=2.0.1; extra == "ci"
+Dynamic: license-file
+
+# GAIK - General AI Kit
+
+Multi-provider AI toolkit for Python with structured data extraction and document parsing.
+
+## Installation
+
+```bash
+# Extract features (OpenAI, Anthropic, Google, Azure)
+pip install gaik[extract]
+
+# PDF parsing
+pip install gaik[parser]
+
+# All features
+pip install gaik[all]
+```
+
+## Quick Start
+
+### Extract Data
+
+```python
+from gaik.extract import SchemaExtractor
+
+# Set API key first: export OPENAI_API_KEY='sk-...'
+extractor = SchemaExtractor("Extract name and age from text")
+result = extractor.extract_one("Alice is 25 years old")
+print(result)  # {'name': 'Alice', 'age': 25}
+
+# Switch provider
+extractor = SchemaExtractor("Extract name and age", provider="anthropic")  # or "google", "azure"
+```
+
+### Parse PDF to Markdown
+
+```python
+from gaik.parsers import VisionParser, get_openai_config
+
+# Set environment: AZURE_API_KEY, AZURE_ENDPOINT, AZURE_DEPLOYMENT
+config = get_openai_config(use_azure=True)
+parser = VisionParser(config)
+
+pages = parser.convert_pdf("invoice.pdf", clean_output=True)
+markdown = "\n\n".join(pages)
+```
+
+### Fast Local PDF Parsing
+
+```python
+from gaik.parsers import PyMuPDFParser
+
+parser = PyMuPDFParser()
+result = parser.parse_document("document.pdf")
+print(result["text_content"])
+```
+
+## Features
+
+### 🔍 Structured Data Extraction
+
+- **Multi-provider** - OpenAI, Anthropic, Google, Azure
+- **Type-safe** - Full Pydantic validation
+- **API-enforced** - Guaranteed schema compliance
+- **Simple** - Natural language to structured data
+
+### 📄 Document Parsing
+
+- **VisionParser** - PDF to Markdown using vision models
+- **PyMuPDFParser** - Fast local text extraction
+- **No external binaries** - Pure Python dependencies
+
+## API Reference
+
+### Extraction
+
+```python
+SchemaExtractor(
+    user_description: str,
+    provider: Literal["openai", "anthropic", "google", "azure"] = "openai",
+    model: str | None = None,
+    api_key: str | None = None,
+)
+```
+
+**Methods:**
+- `extract_one(text: str) -> dict` - Extract from single text
+- `extract(texts: list[str]) -> list[dict]` - Batch extraction
+- `field_names` - List of field names
+- `model` - Generated Pydantic model
+
+### Vision Parser
+
+```python
+VisionParser(
+    config: OpenAIConfig,
+    custom_prompt: str | None = None,
+    use_context: bool = True,
+    max_tokens: int = 16_000,
+)
+```
+
+**Methods:**
+- `convert_pdf(pdf_path: str, dpi: int = 200, clean_output: bool = True) -> list[str]`
+- `save_markdown(pages: list[str], output_path: str)`
+
+**Config Helper:**
+```python
+get_openai_config(use_azure: bool = True) -> OpenAIConfig
+```
+
+### PyMuPDF Parser
+
+```python
+PyMuPDFParser()
+```
+
+**Methods:**
+- `parse_document(file_path: str) -> dict` - Extract text and metadata
+
+## Environment Variables
+
+| Provider | Variables |
+|----------|-----------|
+| OpenAI | `OPENAI_API_KEY` |
+| Anthropic | `ANTHROPIC_API_KEY` |
+| Google | `GOOGLE_API_KEY` |
+| Azure | `AZURE_API_KEY`, `AZURE_ENDPOINT`, `AZURE_DEPLOYMENT` |
+
+## Default Models
+
+| Provider | Model |
+|----------|-------|
+| OpenAI | `gpt-4.1` |
+| Anthropic | `claude-sonnet-4-5-20250929` |
+| Google | `gemini-2.5-flash` |
+| Azure | User's deployment |
+
+## Batch Processing
+
+```python
+extractor = SchemaExtractor("""
+Extract:
+- invoice_number: Invoice ID
+- amount: Total in USD
+- vendor: Company name
+""")
+
+documents = [
+    "Invoice #12345 from Acme Corp. Total: $1,500",
+    "INV-67890, Supplier: TechCo, Amount: $2,750"
+]
+
+results = extractor.extract(documents)
+for result in results:
+    print(f"Invoice: {result['invoice_number']}, Amount: ${result['amount']}")
+```
+
+## Schema Inspection
+
+```python
+extractor = SchemaExtractor("Extract name and age")
+
+# Field names
+print(extractor.field_names)  # ['name', 'age']
+
+# JSON schema
+schema = extractor.model.model_json_schema()
+
+# Field specs
+for field in extractor.fields:
+    print(f"{field.field_name}: {field.field_type}")
+```
+
+## Advanced Usage
+
+### Custom Prompt for Vision Parser
+
+```python
+custom_prompt = """
+Convert document to markdown:
+- Preserve all tables
+- Include headers and footers
+- Maintain layout structure
+"""
+
+parser = VisionParser(config, custom_prompt=custom_prompt)
+```
+
+### Pre-defined Schema
+
+```python
+from gaik.extract import FieldSpec, ExtractionRequirements, create_extraction_model
+
+requirements = ExtractionRequirements(
+    use_case_name="Invoice",
+    fields=[
+        FieldSpec("invoice_number", "str", "Invoice ID", required=True),
+        FieldSpec("amount", "float", "Total amount", required=True),
+    ]
+)
+
+InvoiceModel = create_extraction_model(requirements)
+extractor = SchemaExtractor(requirements=requirements)
+```
+
+## Resources
+
+- **Examples**: [examples/](../../examples/)
+- **Repository**: [github.com/GAIK-project/gaik-toolkit](https://github.com/GAIK-project/gaik-toolkit)
+- **Contributing**: [CONTRIBUTING.md](../../../CONTRIBUTING.md)
+
+## License
+
+MIT - see [LICENSE](../../../LICENSE)

gaik-0.2.17/README.md

@@ -0,0 +1,214 @@
+# GAIK - General AI Kit
+
+Multi-provider AI toolkit for Python with structured data extraction and document parsing.
+
+## Installation
+
+```bash
+# Extract features (OpenAI, Anthropic, Google, Azure)
+pip install gaik[extract]
+
+# PDF parsing
+pip install gaik[parser]
+
+# All features
+pip install gaik[all]
+```
+
+## Quick Start
+
+### Extract Data
+
+```python
+from gaik.extract import SchemaExtractor
+
+# Set API key first: export OPENAI_API_KEY='sk-...'
+extractor = SchemaExtractor("Extract name and age from text")
+result = extractor.extract_one("Alice is 25 years old")
+print(result)  # {'name': 'Alice', 'age': 25}
+
+# Switch provider
+extractor = SchemaExtractor("Extract name and age", provider="anthropic")  # or "google", "azure"
+```
+
+### Parse PDF to Markdown
+
+```python
+from gaik.parsers import VisionParser, get_openai_config
+
+# Set environment: AZURE_API_KEY, AZURE_ENDPOINT, AZURE_DEPLOYMENT
+config = get_openai_config(use_azure=True)
+parser = VisionParser(config)
+
+pages = parser.convert_pdf("invoice.pdf", clean_output=True)
+markdown = "\n\n".join(pages)
+```
+
+### Fast Local PDF Parsing
+
+```python
+from gaik.parsers import PyMuPDFParser
+
+parser = PyMuPDFParser()
+result = parser.parse_document("document.pdf")
+print(result["text_content"])
+```
+
+## Features
+
+### 🔍 Structured Data Extraction
+
+- **Multi-provider** - OpenAI, Anthropic, Google, Azure
+- **Type-safe** - Full Pydantic validation
+- **API-enforced** - Guaranteed schema compliance
+- **Simple** - Natural language to structured data
+
+### 📄 Document Parsing
+
+- **VisionParser** - PDF to Markdown using vision models
+- **PyMuPDFParser** - Fast local text extraction
+- **No external binaries** - Pure Python dependencies
+
+## API Reference
+
+### Extraction
+
+```python
+SchemaExtractor(
+    user_description: str,
+    provider: Literal["openai", "anthropic", "google", "azure"] = "openai",
+    model: str | None = None,
+    api_key: str | None = None,
+)
+```
+
+**Methods:**
+- `extract_one(text: str) -> dict` - Extract from single text
+- `extract(texts: list[str]) -> list[dict]` - Batch extraction
+- `field_names` - List of field names
+- `model` - Generated Pydantic model
+
+### Vision Parser
+
+```python
+VisionParser(
+    config: OpenAIConfig,
+    custom_prompt: str | None = None,
+    use_context: bool = True,
+    max_tokens: int = 16_000,
+)
+```
+
+**Methods:**
+- `convert_pdf(pdf_path: str, dpi: int = 200, clean_output: bool = True) -> list[str]`
+- `save_markdown(pages: list[str], output_path: str)`
+
+**Config Helper:**
+```python
+get_openai_config(use_azure: bool = True) -> OpenAIConfig
+```
+
+### PyMuPDF Parser
+
+```python
+PyMuPDFParser()
+```
+
+**Methods:**
+- `parse_document(file_path: str) -> dict` - Extract text and metadata
+
+## Environment Variables
+
+| Provider | Variables |
+|----------|-----------|
+| OpenAI | `OPENAI_API_KEY` |
+| Anthropic | `ANTHROPIC_API_KEY` |
+| Google | `GOOGLE_API_KEY` |
+| Azure | `AZURE_API_KEY`, `AZURE_ENDPOINT`, `AZURE_DEPLOYMENT` |
+
+## Default Models
+
+| Provider | Model |
+|----------|-------|
+| OpenAI | `gpt-4.1` |
+| Anthropic | `claude-sonnet-4-5-20250929` |
+| Google | `gemini-2.5-flash` |
+| Azure | User's deployment |
+
+## Batch Processing
+
+```python
+extractor = SchemaExtractor("""
+Extract:
+- invoice_number: Invoice ID
+- amount: Total in USD
+- vendor: Company name
+""")
+
+documents = [
+    "Invoice #12345 from Acme Corp. Total: $1,500",
+    "INV-67890, Supplier: TechCo, Amount: $2,750"
+]
+
+results = extractor.extract(documents)
+for result in results:
+    print(f"Invoice: {result['invoice_number']}, Amount: ${result['amount']}")
+```
+
+## Schema Inspection
+
+```python
+extractor = SchemaExtractor("Extract name and age")
+
+# Field names
+print(extractor.field_names)  # ['name', 'age']
+
+# JSON schema
+schema = extractor.model.model_json_schema()
+
+# Field specs
+for field in extractor.fields:
+    print(f"{field.field_name}: {field.field_type}")
+```
+
+## Advanced Usage
+
+### Custom Prompt for Vision Parser
+
+```python
+custom_prompt = """
+Convert document to markdown:
+- Preserve all tables
+- Include headers and footers
+- Maintain layout structure
+"""
+
+parser = VisionParser(config, custom_prompt=custom_prompt)
+```
+
+### Pre-defined Schema
+
+```python
+from gaik.extract import FieldSpec, ExtractionRequirements, create_extraction_model
+
+requirements = ExtractionRequirements(
+    use_case_name="Invoice",
+    fields=[
+        FieldSpec("invoice_number", "str", "Invoice ID", required=True),
+        FieldSpec("amount", "float", "Total amount", required=True),
+    ]
+)
+
+InvoiceModel = create_extraction_model(requirements)
+extractor = SchemaExtractor(requirements=requirements)
+```
+
+## Resources
+
+- **Examples**: [examples/](../../examples/)
+- **Repository**: [github.com/GAIK-project/gaik-toolkit](https://github.com/GAIK-project/gaik-toolkit)
+- **Contributing**: [CONTRIBUTING.md](../../../CONTRIBUTING.md)
+
+## License
+
+MIT - see [LICENSE](../../../LICENSE)

gaik-0.2.17/pyproject.toml

@@ -0,0 +1,131 @@
+[project]
+name = "gaik"
+dynamic = ["version"]
+description = "General AI Kit - Reusable AI/ML components for Python"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [{ name = "GAIK Project" }]
+keywords = [
+    "ai",
+    "ml",
+    "langchain",
+    "openai",
+    "anthropic",
+    "google",
+    "structured-outputs",
+    "pydantic",
+    "schema",
+    "extraction",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+
+dependencies = [
+    # Core runtime requirement shared across all installs
+    "pydantic>=2.12.4",
+]
+
+[project.optional-dependencies]
+# Data extraction with all LLM providers (OpenAI, Anthropic, Google, Azure)
+extract = [
+]
+
+# Document parsing (PDF, images, etc.)
+parser = [
+    # Required to call OpenAI or Azure OpenAI vision endpoints
+    "openai>=2.7",
+    # PDF parsing and image conversion (no Pillow required)
+    "PyMuPDF>=1.23.0",
+    # Environment variable loading
+    "python-dotenv>=1.0.0",
+    "docling",
+    "psutil"
+]
+
+# All features
+all = [
+    "gaik[extract]",
+    "gaik[parser]",
+]
+
+# Development tooling for maintainers only (pip install -e ".[dev]")
+dev = [
+    "ruff>=0.14.1",      # Linter/formatter: ruff check . / ruff format .
+    "build>=1.0",        # Package builder: python -m build
+    "twine>=4.0",        # PyPI publisher: twine upload dist/*
+    "pytest>=8.0",       # Test runner: pytest
+    "pytest-cov>=4.1",   # Coverage reports (optional)
+    "pytest-mock>=3.12", # Mock fixtures for testing
+    "tomli>=2.0.1",      # TOML parser for Python 3.10 tooling
+]
+
+# Continuous integration dependencies (dev + provider extras)
+ci = [
+    # Extraction extras
+    "langchain-core>=1.0.3",
+    "langchain-openai>=1.0.2",
+    "langchain-anthropic>=1.0.1",
+    "langchain-google-genai>=3.0.1",
+    # Development/test tooling
+    "ruff>=0.14.1",
+    "build>=1.0",
+    "twine>=4.0",
+    "pytest>=8.0",
+    "pytest-cov>=4.1",
+    "pytest-mock>=3.12",
+    "tomli>=2.0.1",
+]
+
+[project.urls]
+Homepage = "https://gaik.ai/"
+Repository = "https://github.com/GAIK-project/gaik-toolkit"
+Documentation = "https://github.com/GAIK-project/gaik-toolkit/tree/main/packages/python/gaik"
+Issues = "https://github.com/GAIK-project/gaik-toolkit/issues"
+
+# Build system configuration (not installed, used during `python -m build`)
+[build-system]
+requires = ["setuptools>=61.0", "wheel", "setuptools-scm>=8.0"]
+build-backend = "setuptools.build_meta"
+
+# Source code location (not installed, directs setuptools behavior)
+[tool.setuptools.packages.find]
+where = ["src"]
+exclude = ["gaik.tests", "gaik.*.tests"]
+[tool.setuptools_scm]
+version_file = "src/gaik/_version.py"
+root = "../../.."
+tag_regex = "^v(?P<version>\\d+\\.\\d+\\.\\d+)$"
+fallback_version = "0.0.0"
+version_scheme = "no-guess-dev"
+local_scheme = "no-local-version"
+
+
+# Include type hints marker file (py.typed included in package)
+[tool.setuptools.package-data]
+gaik = ["py.typed"]
+
+# Ruff linter/formatter settings (not installed, used when running `ruff check`)
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+extend-exclude = ["scripts"]  # Exclude CI/CD scripts from linting
+
+# Ruff lint rules configuration
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP"]
+ignore = []
+
+# Pytest test runner configuration
+[tool.pytest.ini_options]
+testpaths = ["src/gaik"]
+addopts = ["-v", "--strict-markers"]

gaik-0.2.17/scripts/README.md

@@ -0,0 +1,28 @@
+# CI/CD Scripts
+
+This directory stores helper scripts that CI workflows call after building or installing the package. Keep them lightweight and dependency-free so they can run in both local and GitHub-hosted environments.
+
+## Available scripts
+
+| Script                   | Purpose                                                                    |
+| ------------------------ | -------------------------------------------------------------------------- |
+| `verify_installation.py` | Smoke test that imports and basic utilities work after `pip install gaik`. |
+
+### verify_installation.py
+
+This script performs quick runtime checks without making network calls:
+
+- Imports the public API (`gaik`, `gaik.extract`, `gaik.providers`).
+- Instantiates a few Pydantic models (no LLM providers needed).
+- Confirms required providers are registered.
+- Prints a ✅ success message and exits 0.
+
+**Used by:** `test.yml` (after unit tests) and `publish.yml` (after uploading to PyPI).
+
+Run manually from the repo root:
+
+```bash
+python packages/python/gaik/scripts/verify_installation.py
+```
+
+> Unit tests now live next to the modules they cover (e.g., `src/gaik/extract/tests`). These scripts are only for CI smoke checks.