openai-sdk-helpers 0.0.7__py3-none-any.whl → 0.0.9__py3-none-any.whl

openai_sdk_helpers-0.0.7.dist-info/METADATA

@@ -1,193 +0,0 @@
-Metadata-Version: 2.4
-Name: openai-sdk-helpers
-Version: 0.0.7
-Summary: Composable helpers for OpenAI SDK agents, prompts, and storage
-Author: openai-sdk-helpers maintainers
-License: MIT
-License-File: LICENSE
-Requires-Python: >=3.10
-Requires-Dist: jinja2
-Requires-Dist: openai
-Requires-Dist: openai-agents
-Requires-Dist: pydantic<3,>=2.7
-Requires-Dist: python-dotenv
-Requires-Dist: typing-extensions<5,>=4.15.0
-Description-Content-Type: text/markdown
-
-<div align="center">
-
-# openai-sdk-helpers
-
-Shared primitives for composing OpenAI agent workflows: structures, response
-handling, prompt rendering, and reusable agent factories.
-
-</div>
-
-## Overview
-
-`openai-sdk-helpers` packages the common building blocks required to assemble agent-driven
-applications. The library intentionally focuses on reusable primitives—data
-structures, configuration helpers, and orchestration utilities—while leaving
-application-specific prompts and tools to the consuming project.
-
-### Features
-
-- **Agent wrappers** for OpenAI Agents SDK with synchronous and asynchronous
-  entry points.
-- **Prompt rendering** powered by Jinja for dynamic agent instructions.
-- **Typed structures** for prompts, responses, and search workflows to ensure
-  predictable inputs and outputs.
-- **Vector and web search flows** that coordinate planning, execution, and
-  reporting.
-- **Reusable text agents** for summarization and translation tasks.
-
-## Installation
-
-Install the package directly from PyPI to reuse it across projects:
-
-```bash
-pip install openai-sdk-helpers
-```
-
-Type information ships with the published wheel via `py.typed`, so external
-projects can rely on the bundled annotations without adding custom stubs.
-
-For local development, install with editable sources and the optional dev
-dependencies:
-
-```bash
-pip install -e .
-pip install -e . --group dev
-```
-
-## Quickstart
-
-Create a basic vector search workflow by wiring your own prompt templates and
-preferred model configuration:
-
-```python
-from pathlib import Path
-
-from openai_sdk_helpers.agent.vector_search import VectorSearch
-
-
-prompts = Path("./prompts")
-vector_search = VectorSearch(prompt_dir=prompts, default_model="gpt-4o-mini")
-
-report = vector_search.run_agent_sync("Explain quantum entanglement for beginners")
-print(report.report)
-```
-
-### Text utilities
-
-Use the built-in text helpers when you need lightweight single-step agents.
-
-```python
-from openai_sdk_helpers.agent import (
-    SummarizerAgent,
-    TranslatorAgent,
-    ValidatorAgent,
-)
-
-
-summarizer = SummarizerAgent(default_model="gpt-4o-mini")
-translator = TranslatorAgent(default_model="gpt-4o-mini")
-validator = ValidatorAgent(default_model="gpt-4o-mini")
-
-summary = summarizer.run_sync("Long-form content to condense")
-translation = translator.run_sync("Bonjour", target_language="English")
-guardrails = validator.run_sync(
-    "Share meeting notes with names removed", agent_output=summary.text
-)
-```
-
-Prompt templates are optional for the built-in text helpers. They already ship
-with defaults under `src/openai_sdk_helpers/prompt`, so you do **not** need to
-create placeholder files when installing from PyPI. Only pass a `prompt_dir`
-when you have real replacements you want to load.
-
-The vector search workflow expects real prompts for each agent (for example,
-`vector_planner.jinja`, `vector_search.jinja`, and `vector_writer.jinja`). If
-you point `prompt_dir` at a folder that does not contain those files, agent
-construction fails with a `FileNotFoundError`. Skip `prompt_dir` entirely unless
-you have working templates ready.
-
-### Centralized OpenAI configuration
-
-`openai-sdk-helpers` ships with a lightweight `OpenAISettings` helper so projects can share
-consistent authentication, routing, and model defaults when using the OpenAI
-SDK:
-
-```python
-from openai_sdk_helpers import OpenAISettings
-
-
-# Load from environment variables or a local .env file
-settings = OpenAISettings.from_env()
-client = settings.create_client()
-
-# Reuse the default model across agents
-vector_search = VectorSearch(
-    prompt_dir=prompts, default_model=settings.default_model or "gpt-4o-mini"
-)
-```
-
-The helper reads `OPENAI_API_KEY`, `OPENAI_ORG_ID`, `OPENAI_PROJECT_ID`,
-`OPENAI_BASE_URL`, `OPENAI_MODEL`, `OPENAI_TIMEOUT`, and `OPENAI_MAX_RETRIES` by
-default but supports overrides for custom deployments. Pass uncommon OpenAI
-client keyword arguments (such as `default_headers`, `http_client`, or
-`base_url` proxies) through `extra_client_kwargs` when instantiating
-`OpenAISettings`.
-
-## Development
-
-The repository is configured for a lightweight Python development workflow.
-Before opening a pull request, format and validate your changes locally:
-
-```bash
-# Style and formatting
-pydocstyle src
-black --check .
-
-# Static type checking
-pyright src
-
-# Unit tests with coverage
-pytest -q --cov=src --cov-report=term-missing --cov-fail-under=70
-```
-
-## Project Structure
-
-- `src/openai_sdk_helpers/agent`: Agent factories, orchestration helpers, and search
-  workflows.
-- `src/openai_sdk_helpers/prompt`: Prompt rendering utilities backed by Jinja.
-- `src/openai_sdk_helpers/response`: Response parsing and transformation helpers.
-- `src/openai_sdk_helpers/structure`: Typed data structures shared across workflows.
-- `src/openai_sdk_helpers/vector_storage`: Minimal vector store abstraction.
-- `tests/`: Unit tests covering core modules and structures.
-
-## Key modules
-
-The package centers around a handful of cohesive building blocks:
-
-- `openai_sdk_helpers.agent.project_manager.ProjectManager` coordinates prompt
-  creation, plan building, task execution, and summarization while persisting
-  intermediate artifacts to disk.
-- `openai_sdk_helpers.agent.vector_search.VectorSearch` bundles the planners,
-  executors, and summarizers required to run a multi-turn vector search flow
-  from a single entry point.
-- `openai_sdk_helpers.agent.summarizer.SummarizerAgent`,
-  `agent.translator.TranslatorAgent`, and `agent.validator.ValidatorAgent`
-  expose streamlined text-processing utilities that reuse shared prompt
-  templates.
-- `openai_sdk_helpers.response` contains the response runners and helpers used
-  to normalize outputs from agents, including streaming responses.
-- `openai_sdk_helpers.utils` holds JSON serialization helpers, logging
-  utilities, and common validation helpers used across modules.
-
-## Contributing
-
-Contributions are welcome! Please accompany functional changes with relevant
-tests and ensure all quality gates pass. Follow the NumPy-style docstring
-conventions outlined in `AGENTS.md` to keep the codebase consistent.
-

openai_sdk_helpers-0.0.7.dist-info/RECORD

@@ -1,51 +0,0 @@
-openai_sdk_helpers/__init__.py,sha256=aqesJ3gPruETXtksvQga-iNJYBQZG6TY2YGK7iNOY6g,1324
-openai_sdk_helpers/config.py,sha256=OH--g7Xp4ftucA2C4o6FCX0M9Z15KMRpkY0lpn0mmOI,6455
-openai_sdk_helpers/environment.py,sha256=t_AFP6OXjRBoIQVZdgjqZzcUWB-FDeYn4KzKn5FgrnY,693
-openai_sdk_helpers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-openai_sdk_helpers/agent/__init__.py,sha256=1sRtu_TbnKR7EstzZjoi2OUOk0xJOTn4xbo5ZeoPIhk,825
-openai_sdk_helpers/agent/base.py,sha256=JHJnI7nW6e6l_FrEVoyHjFd_agE5CAM_E8rUPMrlZsk,10053
-openai_sdk_helpers/agent/config.py,sha256=IZDF83f_QT-1-3GdTVrn9cQCoaaH4KNcrO-ocfc-LwY,1925
-openai_sdk_helpers/agent/project_manager.py,sha256=uYCZyAG8_Snxef4mv5ax-nI_XVvRPUh43I0pY_AdiiU,16249
-openai_sdk_helpers/agent/prompt_utils.py,sha256=8uCm08YuJ94rKgBuIkio2O4EpbwDmTXNfgeddbih8JA,228
-openai_sdk_helpers/agent/runner.py,sha256=-hd_k4h2mmKDpocIIQWQs_5Y9wvq7cLTopmNMwwz3Jc,5375
-openai_sdk_helpers/agent/summarizer.py,sha256=lijBOL7vE7pm4ShquB-j6zJKLmw0X94KAY0zDC6RkD4,2444
-openai_sdk_helpers/agent/translator.py,sha256=Cj3eJ2IakX2UqSeDotgqpbmM89FekpYt3GglM8Qxglw,4229
-openai_sdk_helpers/agent/utils.py,sha256=DTD5foCqGYfXf13F2bZMYIQROl7SbDSy5GDPGi0Zl-0,1089
-openai_sdk_helpers/agent/validation.py,sha256=omKfbClYdPQxxn9WKlw33s42AkudeFw54DmgGSe2UhQ,3216
-openai_sdk_helpers/agent/vector_search.py,sha256=pf_kIFl_TK4ZXvTcZzNqXxZuyq4QfF4ncDluAp4nj0c,15529
-openai_sdk_helpers/agent/web_search.py,sha256=VCsMN75XlwrifqOVMSDYxkrLJ2oJl-yInMdMtx6Puqo,12147
-openai_sdk_helpers/enums/__init__.py,sha256=HhzM9YVDqPijpnKzA-qnzbX62104FrGDcnN-cEYMD_w,149
-openai_sdk_helpers/enums/base.py,sha256=dBrzbIA3Ft2Jy-1PhMImEQeDwH0FXIMGHdg68DsG7WE,697
-openai_sdk_helpers/prompt/__init__.py,sha256=Pio9s99ej0ior5gKr8m-hSUgqkBOgFdNu1xofvjPEf8,2275
-openai_sdk_helpers/prompt/summarizer.jinja,sha256=jliSetWDISbql1EkWi1RB8-L_BXUg8JMkRRsPRHuzbY,309
-openai_sdk_helpers/prompt/translator.jinja,sha256=SZhW8ipEzM-9IA4wyS_r2wIMTAclWrilmk1s46njoL0,291
-openai_sdk_helpers/prompt/validator.jinja,sha256=6t8q_IdxFd3mVBGX6SFKNOert1Wo3YpTOji2SNEbbtE,547
-openai_sdk_helpers/response/__init__.py,sha256=LOCBPGe--iKHHCU1WVcljXV5tLFFRdv1dTJZeip7gc8,505
-openai_sdk_helpers/response/base.py,sha256=vOibHp9xQiC4Nu-kNJ8GutRCwBPAtShgybf9_T_lHWk,19593
-openai_sdk_helpers/response/messages.py,sha256=Ot432B9qbbvinGG0aO6mWYeeEUSVqmLiNlvulKbUlZQ,6487
-openai_sdk_helpers/response/runner.py,sha256=OD-lNgpuhBULKS9-fyYAicKONdx_Tk48qGOzVBmG00s,2536
-openai_sdk_helpers/response/tool_call.py,sha256=kYUfkjmkLbEJun_QByMuAvYjdixwoRAjHNy2Sk_riXA,1937
-openai_sdk_helpers/response/vector_store.py,sha256=wCPPppzCQ-PYSS4T2QHqDUHcPMYNlQFeV-Pu33KBRy8,2418
-openai_sdk_helpers/structure/__init__.py,sha256=GBD48p3M9wnOPmEO9t9t5XuiMQedmDBClKmjDLEjcUo,1129
-openai_sdk_helpers/structure/agent_blueprint.py,sha256=opL-dER3a_f_JWC3Jx9ovRdbC4XZe9X20-o1YUq9sgw,7569
-openai_sdk_helpers/structure/base.py,sha256=FJvB-HedXG02VJEEgymMd2adcJCwugdGHidj4ne7phU,22975
-openai_sdk_helpers/structure/prompt.py,sha256=Yovho9WA1AZP1FhKBieBpVThrUn62g4k40mxNrBoY9s,582
-openai_sdk_helpers/structure/responses.py,sha256=KivhRltUlrK8ey9Tk9rDNceHb7uC2gNE38iQJXFOxug,3507
-openai_sdk_helpers/structure/summary.py,sha256=zYRKuBjZHz0GvLRofvJdfD9u101xKgVhFc5CZIlscUE,1682
-openai_sdk_helpers/structure/validation.py,sha256=IdlPb3I1PdCah7kciE8iDRZy_ltk5GSXQyRJUufz7K0,1405
-openai_sdk_helpers/structure/vector_search.py,sha256=M3TQwxOg9mJmZcLgx7UhZkclnbdcH2K_N-XxUU9Eoxo,2457
-openai_sdk_helpers/structure/web_search.py,sha256=XGJS5S-a0t62k7y8r65JzCEdIQh_5dr10EPT-k134Ys,1371
-openai_sdk_helpers/structure/plan/__init__.py,sha256=OVTGp0MAb8RLjE7TZk5zoXjXIih7zzfwPYIyO7CCwVM,261
-openai_sdk_helpers/structure/plan/enum.py,sha256=EYGdUckSUSOXQCTIbD8RhSQNylgVTVvOnb7za6fv6_A,1772
-openai_sdk_helpers/structure/plan/plan.py,sha256=33qBu-yzFEpYHVsvGiGMsdZphYpOD7eT5AjNQzt5cmo,7480
-openai_sdk_helpers/structure/plan/task.py,sha256=Qn-GXV0VuOYA-EHXSC6tQlcXObKMeV3-TQhgeepl2L8,3481
-openai_sdk_helpers/utils/__init__.py,sha256=JRmAwQz2qE0bNhshAq5HAlXjYMyE5OqLl-vOKcD6MZY,463
-openai_sdk_helpers/utils/core.py,sha256=mKCkGE1cC06ZcOip70eiA8rJ4jaRmnGm4zJfwDPLkQM,8161
-openai_sdk_helpers/vector_storage/__init__.py,sha256=BjUueFnxmF4T6YOCra2nqa8rEAzsihEYWavkYB7S_lM,384
-openai_sdk_helpers/vector_storage/cleanup.py,sha256=6e_A9MAOKhJl_9EbRgGiB0NrrN79IwN0mMnHrwp4gd8,2964
-openai_sdk_helpers/vector_storage/storage.py,sha256=-Yk9RwzG6ABkhH1p3Y-6tv5sGu2MdxHvwkxEtB9N9_c,19295
-openai_sdk_helpers/vector_storage/types.py,sha256=9u5oBxKTDf_ljvbWhp1dWVW1zrlVwLd4OpikygvlKJI,1298
-openai_sdk_helpers-0.0.7.dist-info/METADATA,sha256=zYMBq4ke7ex0StA0Q4ddjD4GAsx9cI8oEWTXpZOV1SY,6557
-openai_sdk_helpers-0.0.7.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-openai_sdk_helpers-0.0.7.dist-info/licenses/LICENSE,sha256=CUhc1NrE50bs45tcXF7OcTQBKEvkUuLqeOHgrWQ5jaA,1067
-openai_sdk_helpers-0.0.7.dist-info/RECORD,,