openai-sdk-helpers 0.0.2__tar.gz

openai_sdk_helpers-0.0.2/.github/dependabot.yml

@@ -0,0 +1,10 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+version: 2
+updates:
+  - package-ecosystem: "" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

openai_sdk_helpers-0.0.2/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: Python CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: "pip"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e . --group dev
+
+    - name: Run style checks
+      run: |
+        pydocstyle .
+        black --check .
+
+    - name: Run static type analysis
+      run: |
+        pyright .
+
+    - name: Run tests with coverage
+      run: |
+        pytest -q --cov=src --cov-report=term-missing --cov-fail-under=70

openai_sdk_helpers-0.0.2/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

openai_sdk_helpers-0.0.2/.gitignore

@@ -0,0 +1,207 @@
+# 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__/

openai_sdk_helpers-0.0.2/AGENTS.md

@@ -0,0 +1,82 @@
+# AGENTS.md
+
+These instructions apply to any automated agent contributing to this repository.
+
+## 1. Code Style
+
+- Use standard PEP 8 formatting for all Python code.
+- Write commit messages in the imperative mood (e.g., "Add feature" not "Added feature").
+- Keep the implementation Pythonic and maintainable.
+
+## 2. Docstring Style
+
+- Use **NumPy-style** docstrings following [PEP 257](https://peps.python.org/pep-0257/) conventions.
+- **Do not** use `:param` / `:type` syntax (reST/Sphinx style) or Google-style `Args`.
+- Always include type hints in function signatures.
+- Begin docstrings with a **short, one-line summary**, followed by a blank line and an optional extended description.
+- Use the following NumPy-style sections:
+  - `Parameters`
+  - `Returns`
+  - `Raises`
+  - `Examples`
+- Document all public classes, methods, and functions.
+- **For classes, the main docstring should include a `Methods` section summarizing each public method and its one-line description.**
+- For optional parameters, note the default value in the description.
+- Use imperative present tense and active voice (“Return…”, “Fetch…”).
+
+## 3. Code Quality and Testing
+
+Before running tests, install the development dependencies:
+
+```bash
+# Install the package with dev dependency group (PEP 735)
+pip install -e . --group dev
+```
+
+To ensure your changes will pass the automated checks in our Continuous Integration (CI) pipeline, run the following commands locally before committing. All checks must pass.
+
+**Style Checks:**
+```bash
+pydocstyle src
+black --check .
+```
+
+**Static Type Analysis:**
+```bash
+pyright src
+```
+
+**Unit Tests and Coverage:**
+```bash
+pytest -q --cov=src --cov-report=term-missing --cov-fail-under=70
+```
+
+## 4. Directory Layout
+
+- Production code lives in `src/`.
+- Tests live in `tests/`.
+- Keep imports relative within the package (e.g., `from rda_bundle...`).
+
+## 5. Pull Request Messages
+
+Each pull request should include:
+
+1. **Summary** – brief description of the change.
+2. **Testing** – commands run and confirmation that the tests passed.
+
+Example PR body:
+
+```
+### Summary
+- add new helper to utils.list
+- expand tests for list chunking
+
+### Testing
+- `pytest` (all tests passed)
+```
+
+## 6. General Guidelines
+
+- Avoid pushing large data files to the repository.
+- Prefer small, focused commits over sweeping changes.
+- Update or add tests whenever you modify functionality.

openai_sdk_helpers-0.0.2/LICENSE

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

openai_sdk_helpers-0.0.2/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: openai-sdk-helpers
+Version: 0.0.2
+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.
+
+## Installation
+
+Install the package directly from PyPI to reuse it across projects:
+
+```bash
+pip install openai-sdk-helpers
+```
+
+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)
+```
+
+You can plug in your own prompt templates by placing matching `.jinja` files in
+the provided `prompt_dir` and naming them after the agent (for example,
+`vector_planner.jinja`).
+
+### 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`, and `OPENAI_MODEL` by default but supports overrides for
+custom deployments.
+
+## 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.
+
+## 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.2/README.md

@@ -0,0 +1,121 @@
+<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.
+
+## Installation
+
+Install the package directly from PyPI to reuse it across projects:
+
+```bash
+pip install openai-sdk-helpers
+```
+
+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)
+```
+
+You can plug in your own prompt templates by placing matching `.jinja` files in
+the provided `prompt_dir` and naming them after the agent (for example,
+`vector_planner.jinja`).
+
+### 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`, and `OPENAI_MODEL` by default but supports overrides for
+custom deployments.
+
+## 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.
+
+## 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.
+