tasks-prompts-chain 0.0.1__py3-none-any.whl

tasks_prompts_chain/__init__.py

@@ -0,0 +1,3 @@
+from .tasks_prompts_chain import TasksPromptsChain, PromptTemplate, OutputFormat
+
+__all__ = ['TasksPromptsChain', 'PromptTemplate', 'OutputFormat']

tasks_prompts_chain/tasks_prompts_chain.py

@@ -0,0 +1,268 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Filename: tasks_prompts_chain.py
+Author: Samir Ben Sghaier
+Date: 2025-02-08
+Version: 1.0
+Description: 
+    A Python library for creating and executing chains of prompts using 
+    OpenAI's SDK with streaming support and template formatting. 
+Contact: ben.sghaier.samir@gmail.com
+GitHub: https://github.com/smirfolio
+Dependencies: openai, typing-extensions
+
+License: APACHE 2.0 License
+Copyright 2025 Samir Ben Sghaier - Smirfolio
+
+   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.
+
+"""
+from typing import List, Optional, Dict, Union, AsyncGenerator, TypedDict
+from openai import AsyncOpenAI
+from enum import Enum
+
+class OutputFormat(Enum):
+    JSON = "JSON"
+    MARKDOWN = "MARKDOWN"
+    CSV = "CSV"
+    TEXT = "TEXT"
+
+class ModelOptions(TypedDict, total=False):
+    model: str
+    api_key: str 
+    base_url: Optional[str]
+    temperature: Optional[float]
+    max_tokens: Optional[int]
+    stream: Optional[bool]
+
+class PromptTemplate:
+    def __init__(self, prompt: str, output_format: str = "TEXT", output_placeholder: Optional[str] = None):
+        self.prompt = prompt
+        self.output_format = OutputFormat(output_format.upper())
+        self.output_placeholder = output_placeholder
+
+class TasksPromptsChain:
+    """A utility class for creating and executing prompt chains using OpenAI's API."""
+    
+    def __init__(self, 
+                 model_options: ModelOptions,
+                 system_prompt: Optional[str] = None,
+                 final_result_placeholder: Optional[str] = None,
+                 system_apply_to_all_prompts: bool = False):
+        """
+        Initialize the TasksPromptsChain with OpenAI configuration.
+        
+        Args:
+            model_options (ModelOptions): Dictionary containing model configuration:
+                - model (str): The model identifier to use (e.g., 'gpt-3.5-turbo')
+                - api_key (str): The OpenAI API key
+                - base_url (str, optional): API endpoint URL
+                - temperature (float, optional): Temperature parameter (default: 0.7)
+                - max_tokens (int, optional): Maximum tokens (default: 4120)
+                - stream (bool, optional): Whether to stream responses (default: True)
+            system_prompt (str, optional): System prompt to set context for the LLM
+            final_result_placeholder (str, optional): The placeholder name for the final result
+            system_apply_to_all_prompts (bool): Whether to apply system prompt to all prompts
+        """
+        self.model = model_options["model"]
+        self.temperature = model_options.get("temperature", 0.7)
+        self.max_tokens = model_options.get("max_tokens", 4120)
+        self.stream = model_options.get("stream", True)
+        
+        client_kwargs = {"api_key": model_options["api_key"]}
+        if "base_url" in model_options:
+            client_kwargs["base_url"] = model_options["base_url"]
+        self.client = AsyncOpenAI(**client_kwargs)
+        self.system_prompt = system_prompt
+        self.system_apply_to_all_prompts = system_apply_to_all_prompts
+        self.final_result_placeholder = final_result_placeholder or "final_result"
+        self._results = {}
+        self._output_template = None
+        self._current_stream_buffer = ""
+
+    def set_output_template(self, template: str) -> None:
+        """
+        Set the output template to be used for streaming responses.
+        Must be called before execute_chain if template formatting is desired.
+        
+        Args:
+            template (str): Template string containing placeholders in {{placeholder}} format
+        """
+        self._output_template = template
+
+    def _format_current_stream(self) -> str:
+        """
+        Format the current stream buffer using the template.
+        
+        Returns:
+            str: Formatted output using the template
+        """
+        if not self._output_template:
+            return self._current_stream_buffer
+            
+        output = self._output_template
+        # Replace all existing results
+        for placeholder, value in self._results.items():
+            output = output.replace(f"{{{{{placeholder}}}}}", value or "")
+        # Replace current streaming placeholder
+        output = output.replace(f"{{{{{self.final_result_placeholder}}}}}", self._current_stream_buffer)
+        return output
+
+    async def execute_chain(self, prompts: List[Union[Dict, PromptTemplate]], temperature: float = 0.7) -> AsyncGenerator[str, None]:
+        """
+        Execute a chain of prompts sequentially, with placeholder replacement.
+        
+        Args:
+            prompts (List[Union[Dict, PromptTemplate]]): List of prompt templates or dicts with structure:
+                                                        {
+                                                            "prompt": str,
+                                                            "output_format": str,
+                                                            "output_placeholder": str
+                                                        }
+            temperature (float): Temperature parameter for response generation (0.0 to 1.0)
+            
+        Returns:
+            List[str]: List of responses for each prompt
+        """
+        responses = []
+        placeholder_values = {}
+
+        try:
+            for i, prompt_data in enumerate(prompts):
+                # Convert dict to PromptTemplate if necessary
+                if isinstance(prompt_data, dict):
+                    prompt_template = PromptTemplate(
+                        prompt=prompt_data["prompt"],
+                        output_format=prompt_data.get("output_format", "TEXT"),
+                        output_placeholder=prompt_data.get("output_placeholder")
+                    )
+                else:
+                    prompt_template = prompt_data
+
+                # Replace placeholders in the prompt
+                current_prompt = prompt_template.prompt
+                for placeholder, value in placeholder_values.items():
+                    current_prompt = current_prompt.replace(f"{{{{{placeholder}}}}}", value)
+
+                # Format system message based on output format
+                format_instruction = ""
+                if prompt_template.output_format != OutputFormat.TEXT:
+                    format_instruction = f"\nPlease provide your response in {prompt_template.output_format.value} format."
+
+                messages = []
+                if self.system_prompt and (i == 0 or self.system_apply_to_all_prompts):
+                    messages.append({"role": "system", "content": self.system_prompt})
+                messages.append({"role": "user", "content": current_prompt + format_instruction})
+                
+                stream = await self.client.chat.completions.create(
+                    model=self.model,
+                    messages=messages,
+                    temperature=self.temperature,
+                    max_tokens=self.max_tokens,
+                    stream=self.stream
+                )
+                
+                response_content = ""
+                self._current_stream_buffer = ""
+                
+                async for chunk in stream:
+                    if chunk.choices[0].delta.content is not None:
+                        delta = chunk.choices[0].delta.content
+                        response_content += delta
+                        self._current_stream_buffer = response_content
+                        yield self._format_current_stream()
+                
+                responses.append(response_content)
+                
+                # Store response with placeholder if specified
+                if prompt_template.output_placeholder:
+                    placeholder_values[prompt_template.output_placeholder] = response_content
+                    self._results[prompt_template.output_placeholder] = response_content
+
+        except Exception as e:
+            raise Exception(f"Error in prompt chain execution at prompt {i}: {str(e)}")
+
+        # Store the last response with the final result placeholder
+        if responses:
+            self._results[self.final_result_placeholder] = responses[-1]
+
+    def get_result(self, placeholder: str) -> Optional[str]:
+        """
+        Get the result of a specific prompt by its placeholder.
+        
+        Args:
+            placeholder (str): The output_placeholder value used in the prompt
+            
+        Returns:
+            Optional[str]: The response for that placeholder if it exists, None otherwise
+        """
+        return self._results.get(placeholder)
+
+    def template_output(self, template: str) -> None:
+        """
+        Set the output template for streaming responses.
+        Must be called before execute_chain.
+        
+        Args:
+            template (str): Template string containing placeholders in {{placeholder}} format
+            
+        Raises:
+            Exception: If called after execute_chain has already been run
+        """
+        if len(self._results) > 0:
+            raise Exception("template_output must be called before execute_chain")
+        self.set_output_template(template)
+
+    def execute_chain_with_system(self, prompts: List[str], system_prompt: str, temperature: float = 0.7) -> List[str]:
+        """
+        Execute a chain of prompts with a system prompt included.
+        
+        Args:
+            prompts (List[str]): List of prompts to process in sequence
+            system_prompt (str): System prompt to set context for all interactions
+            temperature (float): Temperature parameter for response generation (0.0 to 1.0)
+            
+        Returns:
+            List[str]: List of responses for each prompt
+        """
+        responses = []
+        context = ""
+
+        try:
+            for i, prompt in enumerate(prompts):
+                # Combine previous context with current prompt if not the first prompt
+                full_prompt = f"{context}\n{prompt}" if context else prompt
+                
+                response = self.client.chat.completions.create(
+                    model=self.model,
+                    messages=[
+                        {"role": "system", "content": system_prompt},
+                        {"role": "user", "content": full_prompt}
+                    ],
+                    temperature=temperature,
+                    max_tokens=4120,
+                    stream=True
+                )
+                
+                # Extract the response content
+                response_content = response.choices[0].message.content
+                responses.append(response_content)
+                
+                # Update context for next iteration
+                context = response_content
+
+        except Exception as e:
+            raise Exception(f"Error in prompt chain execution at prompt {i}: {str(e)}")
+
+        return responses

tasks_prompts_chain-0.0.1.dist-info/METADATA

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: tasks_prompts_chain
+Version: 0.0.1
+Summary: A Python library for creating and executing chains of prompts using OpenAI's SDK with streaming support and template formatting.
+Project-URL: Homepage, https://github.com/smirfolio/tasks_prompts_chain
+Project-URL: Issues, https://github.com/smirfolio/tasks_prompts_chain/issues
+Author-email: Samir Ben Sghaier <ben.sghaier.samir@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# PromptChain
+
+A Mini Python library for creating and executing chains of prompts using OpenAI's API with streaming support and output template formatting.
+
+## Features
+
+- Sequential prompt chain execution
+- Streaming responses
+- Template-based output formatting
+- System prompt support
+- Placeholder replacement between prompts
+- Multiple output formats (JSON, Markdown, CSV, Text)
+- Async/await support
+
+## Installation
+
+### For Users
+```bash
+pip install -r requirements/requirements.txt
+```
+
+### For Developers
+```bash
+pip install -r requirements/requirements.txt
+pip install -r requirements/requirements-dev.txt
+```
+
+## Quick Start
+
+```python
+from tasks_prompts_chain import TasksPromptsChain
+
+async def main():
+    # Initialize the chain
+    chain = TasksPromptsChain(
+        model="gpt-3.5-turbo",
+        api_key="your-api-key",
+        final_result_placeholder="design_result"
+    )
+
+    # Define your prompts
+    prompts = [
+        {
+            "prompt": "Create a design concept for a luxury chocolate bar",
+            "output_format": "TEXT",
+            "output_placeholder": "design_concept"
+        },
+        {
+            "prompt": "Based on this concept: {{design_concept}}, suggest a color palette",
+            "output_format": "JSON",
+            "output_placeholder": "color_palette"
+        }
+    ]
+
+    # Stream the responses
+    async for chunk in chain.execute_chain(prompts):
+        print(chunk, end="", flush=True)
+
+    # Get specific results
+    design = chain.get_result("design_concept")
+    colors = chain.get_result("color_palette")
+```
+
+## Advanced Usage
+
+### Using Templates
+
+```python
+# Set output template before execution
+chain.template_output("""
+<result>
+    <design>
+    ### Design Concept:
+    {{design_concept}}
+    </design>
+    
+    <colors>
+    ### Color Palette:
+    {{color_palette}}
+    </colors>
+</result>
+""")
+```
+
+### Using System Prompts
+
+```python
+chain = TasksPromptsChain(
+    model="gpt-3.5-turbo",
+    api_key="your-api-key",
+    final_result_placeholder="result",
+    system_prompt="You are a professional design expert specialized in luxury products",
+    system_apply_to_all_prompts=True
+)
+```
+
+### Custom API Endpoint
+
+```python
+chain = TasksPromptsChain(
+    model="gpt-3.5-turbo",
+    api_key="your-api-key",
+    final_result_placeholder="result",
+    base_url="https://your-custom-endpoint.com/v1"
+)
+```
+
+## API Reference
+
+### TasksPromptsChain Class
+
+#### Constructor Parameters
+
+- `model` (str): The model identifier (e.g., 'gpt-3.5-turbo')
+- `api_key` (str): Your OpenAI API key
+- `final_result_placeholder` (str): Name for the final result placeholder
+- `system_prompt` (Optional[str]): System prompt for context
+- `system_apply_to_all_prompts` (Optional[bool]): Apply system prompt to all prompts
+- `base_url` (Optional[str]): Custom API endpoint URL
+
+#### Methods
+
+- `execute_chain(prompts: List[Dict], temperature: float = 0.7) -> AsyncGenerator[str, None]`
+  - Executes the prompt chain and streams responses
+  
+- `template_output(template: str) -> None`
+  - Sets the output template format
+  
+- `get_result(placeholder: str) -> Optional[str]`
+  - Retrieves a specific result by placeholder
+
+### Prompt Format
+
+Each prompt in the chain can be defined as a dictionary:
+```python
+{
+    "prompt": str,           # The actual prompt text
+    "output_format": str,    # "JSON", "MARKDOWN", "CSV", or "TEXT"
+    "output_placeholder": str # Identifier for accessing this result
+}
+```
+
+## Error Handling
+
+The library includes comprehensive error handling:
+- Template validation
+- API error handling
+- Placeholder validation
+
+Errors are raised with descriptive messages indicating the specific issue and prompt number where the error occurred.
+
+## Best Practices
+
+1. Always set templates before executing the chain
+2. Use meaningful placeholder names
+3. Handle streaming responses appropriately
+4. Consider temperature settings based on your use case
+5. Use system prompts for consistent context
+
+## License
+
+MIT License

tasks_prompts_chain-0.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+tasks_prompts_chain/__init__.py,sha256=HVhC_vMTYCyZW6vnoErHh-TkAnNRqJ2JJqClJQSfU8Y,148
+tasks_prompts_chain/tasks_prompts_chain.py,sha256=epD997ELkacml3pJibbgKEo-IhlKwLx8J5uJtuJ6uWw,11416
+tasks_prompts_chain-0.0.1.dist-info/METADATA,sha256=Sds4Upqje_iKrhGWmuubtGftdOhrs1Uy0RgvNpQjffk,4613
+tasks_prompts_chain-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+tasks_prompts_chain-0.0.1.dist-info/licenses/LICENSE,sha256=WYmcYJG1QFgu1hfo7qrEkZ3Jhcz8NUWe6XUraZvlIFs,10172
+tasks_prompts_chain-0.0.1.dist-info/RECORD,,

tasks_prompts_chain-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

tasks_prompts_chain-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,176 @@
+                                 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