genai-forge 0.1.3__tar.gz

genai_forge-0.1.3/.github/workflows/release.yml

@@ -0,0 +1,146 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+a[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+b[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
+
+env:
+  PACKAGE_NAME: "genai-forge"
+  OWNER: "ToolForge-AI"
+  TAP_NAME: "genai-forge"
+
+jobs:
+  details:
+    runs-on: ubuntu-latest
+    outputs:
+      new_version: ${{ steps.release.outputs.new_version }}
+      suffix: ${{ steps.release.outputs.suffix }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Extract tag and Details
+        id: release
+        run: |
+          if [ "${{ github.ref_type }}" = "tag" ]; then
+            TAG_NAME=${GITHUB_REF#refs/tags/}
+            NEW_VERSION=$(echo $TAG_NAME | awk -F'-' '{print $1}')
+            SUFFIX=$(echo $TAG_NAME | grep -oP '[a-z]+[0-9]+' || echo "")
+            echo "new_version=$NEW_VERSION" >> "$GITHUB_OUTPUT"
+            echo "suffix=$SUFFIX" >> "$GITHUB_OUTPUT"
+            echo "tag_name=$TAG_NAME" >> "$GITHUB_OUTPUT"
+            echo "Version is $NEW_VERSION"
+            echo "Suffix is $SUFFIX"
+            echo "Tag name is $TAG_NAME"
+          else
+            echo "No tag found"
+            exit 1
+          fi
+
+  check_pypi:
+    needs: details
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch information from PyPI
+        run: |
+          response=$(curl -s https://pypi.org/pypi/${{ env.PACKAGE_NAME }}/json || echo "{}")
+          latest_previous_version=$(echo $response | jq --raw-output "select(.releases != null) | .releases | keys_unsorted | last")
+          if [ -z "$latest_previous_version" ]; then
+            echo "Package not found on PyPI."
+            latest_previous_version="0.0.0"
+          fi
+          echo "Latest version on PyPI: $latest_previous_version"
+          echo "latest_previous_version=$latest_previous_version" >> $GITHUB_ENV
+
+      - name: Compare versions and exit if not newer
+        run: |
+          NEW_VERSION=${{ needs.details.outputs.new_version }}
+          LATEST_VERSION=$latest_previous_version
+          if [ "$(printf '%s\n' "$LATEST_VERSION" "$NEW_VERSION" | sort -rV | head -n 1)" != "$NEW_VERSION" ] || [ "$NEW_VERSION" == "$LATEST_VERSION" ]; then
+            echo "The new version $NEW_VERSION is not greater than the latest version $LATEST_VERSION on PyPI."
+            exit 1
+          else
+            echo "The new version $NEW_VERSION is greater than the latest version $LATEST_VERSION on PyPI."
+          fi
+
+  setup_and_build:
+    needs: [details, check_pypi]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install Poetry
+        run: |
+          curl -sSL https://install.python-poetry.org | python3 -
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Set project version with Poetry
+        run: |
+          poetry version ${{ needs.details.outputs.new_version }}
+
+      - name: Install dependencies
+        run: poetry install --sync --no-interaction
+
+      - name: Build source and wheel distribution
+        run: |
+          poetry build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  pypi_publish:
+    name: Upload release to PyPI
+    needs: [setup_and_build, details]
+    runs-on: ubuntu-latest
+    environment:
+      name: release
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github_release:
+    name: Create GitHub Release
+    needs: [setup_and_build, details]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        id: create_release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create ${{ needs.details.outputs.tag_name }} dist/* --title ${{ needs.details.outputs.tag_name }} --generate-notes
+
+  

genai_forge-0.1.3/.gitignore

@@ -0,0 +1,46 @@
+# Python bytecode and caches
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environments
+.venv/
+venv/
+
+# Environment files
+.env
+.env.*
+
+# Build artifacts
+build/
+dist/
+*.egg-info/
+pip-wheel-metadata/
+
+# Test and tool caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.cache/
+.ipynb_checkpoints/
+.coverage*
+coverage.xml
+htmlcov/
+.tox/
+
+# IDE/editor settings
+.vscode/
+.idea/
+*.iml
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+
+# Lock files (optional; remove if you want to track)
+uv.lock
+
+

genai_forge-0.1.3/.python-version

@@ -0,0 +1 @@
+3.10

genai_forge-0.1.3/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

genai_forge-0.1.3/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: genai-forge
+Version: 0.1.3
+Summary: Generative AI tools from ToolForge-AI organization
+Project-URL: Homepage, https://github.com/ToolForge-AI/genai-forge
+Project-URL: Repository, https://github.com/ToolForge-AI/genai-forge
+Project-URL: Issues, https://github.com/your-org/ToolForge-AI/issues
+Author-email: Daniel Aguilera <daniel.aguilera@toolforge-ai.com>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: openai>=2.7.1
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: python-dotenv>=1.0.0
+Description-Content-Type: text/markdown
+
+# genai-forge
+
+Lightweight utilities to call LLMs and parse their outputs with Pydantic.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install genai-forge
+```
+
+## Requirements
+
+- Python 3.10+
+- An OpenAI API key in your environment:
+  - Create a `.env` file at your project root with:
+
+```bash
+OPENAI_API_KEY=sk-...
+```
+
+`genai_forge` will load `.env` automatically via `python-dotenv` when using the OpenAI provider.
+
+## Quick start
+
+```python
+from genai_forge.llm import create_llm
+from genai_forge.prompting import PromptTemplate
+
+template = PromptTemplate(
+    system="You are a concise expert assistant.",
+    template="Generate one actionable tip.\nAudience: {audience}\nTime: {time}",
+)
+
+llm = create_llm("openai:gpt-4o-mini", temperature=0.2)
+
+# Chain: query | template | llm
+query = "Provide a short productivity tip."
+chain = query | template | llm
+print(chain({"audience": "Backend Python developer", "time": "30 minutes"}))
+```
+
+## Parsing structured outputs with Pydantic
+
+Use `PydanticOutputParser` to have the LLM return valid JSON that is validated into a Pydantic model. When you add a parser to the chain, the parser’s format instructions are automatically appended to the prompt; you do not need to place `{instructions}` in your template.
+
+```python
+from typing import List
+from pydantic import BaseModel
+from genai_forge.llm import create_llm
+from genai_forge import PydanticOutputParser
+from genai_forge.prompting import PromptTemplate
+
+class CityPlan(BaseModel):
+    city: str
+    attractions: List[str]
+    days: int
+
+template = PromptTemplate(
+    system="You are a helpful travel planner.",
+    template="Create a city plan.\nCity: {city}\nDays: {days}",
+)
+
+llm = create_llm("openai:gpt-4o-mini", temperature=0.1)
+parser = PydanticOutputParser(CityPlan)
+
+# Chain: query | template | llm | parser
+query = "Create a 2-day city plan for Kyoto."
+chain = query | template | llm | parser
+result = chain({"city": "Kyoto", "days": 2})  # -> CityPlan
+print(result)
+```
+
+### What chaining does
+
+The `|` operator builds a Chain:
+- `template | llm` produces a function that formats the prompt (system + user) and calls the LLM.
+- `template | llm | parser` also injects the parser's format instructions automatically into the prompt and validates the output.
+
+## Output parser: how it works
+
+`PydanticOutputParser`:
+- Accepts tolerant output formats (e.g., extra text or ```json fences).
+- Extracts JSON from the text (tries direct parse, then finds the first balanced `{...}` block).
+- Validates the JSON against your Pydantic model.
+- Provides `get_format_instructions()`; the Chain appends it for you when a parser is present.
+
+API surface:
+
+```python
+from genai_forge import PydanticOutputParser, BaseOutputParser, OutputParserException
+```
+
+Key methods:
+- `get_format_instructions() -> str`: Include in your prompt.
+- `parse(text: str) -> BaseModel`: Parse and validate output.
+
+## Provider configuration
+
+By default, models without an explicit provider use `openai`. You can specify:
+
+```python
+create_llm("openai:gpt-4o-mini")
+# or
+create_llm("gpt-4.1", provider="openai")
+```
+
+The OpenAI provider reads the key from `OPENAI_API_KEY` (or `api_key` argument).
+
+## Running the example
+
+An `example.py` is included at the repo root. It demonstrates:
+- A chain: user input → PromptTemplate (with system prompt) → LLM → PydanticOutputParser
+- Automatic format instructions injection
+
+Ensure you have a `.env` with `OPENAI_API_KEY`, then:
+
+```bash
+python example.py
+```
+
+## License
+
+See `LICENSE`.

genai_forge-0.1.3/README.md

@@ -0,0 +1,125 @@
+# genai-forge
+
+Lightweight utilities to call LLMs and parse their outputs with Pydantic.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install genai-forge
+```
+
+## Requirements
+
+- Python 3.10+
+- An OpenAI API key in your environment:
+  - Create a `.env` file at your project root with:
+
+```bash
+OPENAI_API_KEY=sk-...
+```
+
+`genai_forge` will load `.env` automatically via `python-dotenv` when using the OpenAI provider.
+
+## Quick start
+
+```python
+from genai_forge.llm import create_llm
+from genai_forge.prompting import PromptTemplate
+
+template = PromptTemplate(
+    system="You are a concise expert assistant.",
+    template="Generate one actionable tip.\nAudience: {audience}\nTime: {time}",
+)
+
+llm = create_llm("openai:gpt-4o-mini", temperature=0.2)
+
+# Chain: query | template | llm
+query = "Provide a short productivity tip."
+chain = query | template | llm
+print(chain({"audience": "Backend Python developer", "time": "30 minutes"}))
+```
+
+## Parsing structured outputs with Pydantic
+
+Use `PydanticOutputParser` to have the LLM return valid JSON that is validated into a Pydantic model. When you add a parser to the chain, the parser’s format instructions are automatically appended to the prompt; you do not need to place `{instructions}` in your template.
+
+```python
+from typing import List
+from pydantic import BaseModel
+from genai_forge.llm import create_llm
+from genai_forge import PydanticOutputParser
+from genai_forge.prompting import PromptTemplate
+
+class CityPlan(BaseModel):
+    city: str
+    attractions: List[str]
+    days: int
+
+template = PromptTemplate(
+    system="You are a helpful travel planner.",
+    template="Create a city plan.\nCity: {city}\nDays: {days}",
+)
+
+llm = create_llm("openai:gpt-4o-mini", temperature=0.1)
+parser = PydanticOutputParser(CityPlan)
+
+# Chain: query | template | llm | parser
+query = "Create a 2-day city plan for Kyoto."
+chain = query | template | llm | parser
+result = chain({"city": "Kyoto", "days": 2})  # -> CityPlan
+print(result)
+```
+
+### What chaining does
+
+The `|` operator builds a Chain:
+- `template | llm` produces a function that formats the prompt (system + user) and calls the LLM.
+- `template | llm | parser` also injects the parser's format instructions automatically into the prompt and validates the output.
+
+## Output parser: how it works
+
+`PydanticOutputParser`:
+- Accepts tolerant output formats (e.g., extra text or ```json fences).
+- Extracts JSON from the text (tries direct parse, then finds the first balanced `{...}` block).
+- Validates the JSON against your Pydantic model.
+- Provides `get_format_instructions()`; the Chain appends it for you when a parser is present.
+
+API surface:
+
+```python
+from genai_forge import PydanticOutputParser, BaseOutputParser, OutputParserException
+```
+
+Key methods:
+- `get_format_instructions() -> str`: Include in your prompt.
+- `parse(text: str) -> BaseModel`: Parse and validate output.
+
+## Provider configuration
+
+By default, models without an explicit provider use `openai`. You can specify:
+
+```python
+create_llm("openai:gpt-4o-mini")
+# or
+create_llm("gpt-4.1", provider="openai")
+```
+
+The OpenAI provider reads the key from `OPENAI_API_KEY` (or `api_key` argument).
+
+## Running the example
+
+An `example.py` is included at the repo root. It demonstrates:
+- A chain: user input → PromptTemplate (with system prompt) → LLM → PydanticOutputParser
+- Automatic format instructions injection
+
+Ensure you have a `.env` with `OPENAI_API_KEY`, then:
+
+```bash
+python example.py
+```
+
+## License
+
+See `LICENSE`.