Added patchflow to generate usage example (#1034)

* added patchflow to generate usage example

* fix: changed name of patchflow

Author: plon-Susk7

.github/workflows/test.yml

@@ -13,7 +13,9 @@ on:
       - generatereadme-*
       - generatedocstring-*
       - generateunittests-*
+      - generatecodeusageexample-*
       - resolveissue-*
+
       - demo*
 
 # Credits to https://blog.maximeheckel.com/posts/building-perfect-github-action-frontend-teams/#you-are-terminated
@@ -231,6 +233,14 @@ jobs:
           --github_api_key=${{ secrets.SCM_GITHUB_KEY }} \
           --folder_path=tests/cicd/generate_docstring \
           --disable_telemetry
+      
+      - name: Generate Code Usage Example
+        run: |
+          poetry run patchwork GenerateCodeUsageExample --log debug \
+          --patched_api_key=${{ secrets.PATCHED_API_KEY }} \
+          --github_api_key=${{ secrets.SCM_GITHUB_KEY }} \
+          --folder_path=tests/cicd/generate_docstring \
+          --disable_telemetry
 
       - name: Generate README
         run: |

patchwork/patchflows/GenerateCodeUsageExample/GenerateCodeUsageExample.py

@@ -0,0 +1,61 @@
+import json
+from pathlib import Path
+import yaml
+
+from patchwork.common.utils.step_typing import validate_steps_with_inputs
+from patchwork.step import Step
+from patchwork.steps import (
+    LLM, 
+    CallCode2Prompt,
+    ModifyCode,
+    PR
+)
+
+_DEFAULT_INPUT_FILE = Path(__file__).parent / "defaults.yml"
+_DEFAULT_PROMPT_JSON = Path(__file__).parent / "default_prompt.json"
+
+class GenerateCodeUsageExample(Step):
+    def __init__(self, inputs):
+        super().__init__(inputs)
+
+        final_inputs = yaml.safe_load(_DEFAULT_INPUT_FILE.read_text())
+        if final_inputs is None:
+            final_inputs = {}
+        
+        final_inputs.update(inputs)
+
+        final_inputs["prompt_id"] = "GenerateUsageExample"
+        if "folder_path" not in final_inputs.keys():
+            final_inputs["folder_path"] = Path.cwd()
+        else:
+            final_inputs["folder_path"] = Path(final_inputs["folder_path"])
+
+        if "prompt_template_file" not in final_inputs:
+            final_inputs["prompt_template_file"] = _DEFAULT_PROMPT_JSON
+
+        final_inputs["pr_title"] = f"PatchWork Usage Example generated"
+        final_inputs["branch_prefix"] = f"{self.__class__.__name__.lower()}-"
+
+        validate_steps_with_inputs(
+            set(final_inputs.keys()).union({"prompt_values","files_to_patch"}), LLM, CallCode2Prompt,ModifyCode,PR
+        )
+        self.inputs = final_inputs
+
+    def run(self):
+        outputs = CallCode2Prompt(self.inputs).run()
+        new_file_name = f"usage_example.{self.inputs['test_file_extension']}"
+        new_file_path = Path(outputs['uri']).with_name(new_file_name)
+        Path(outputs['uri']).rename(new_file_path)
+        outputs['uri'] = str(new_file_path)
+        self.inputs["response_partitions"] = {"patch": ["```", "\n", "```"]}
+        self.inputs["files_to_patch"] = self.inputs["prompt_values"] = [outputs]
+        outputs = LLM(self.inputs).run()
+        self.inputs.update(outputs)
+        outputs = ModifyCode(self.inputs).run()
+        self.inputs.update(outputs)
+        number = len(self.inputs["modified_code_files"])
+        self.inputs["pr_header"] = f"This pull request adds usage example."
+        outputs = PR(self.inputs).run()
+        self.inputs.update(outputs)
+
+        return self.inputs

patchwork/patchflows/GenerateCodeUsageExample/README.md

@@ -0,0 +1,11 @@
+## Contents of GenerateUsageExample Code
+
+### Inputs
+- The code reads default inputs from a YAML file (`defaults.yml`) and a JSON file (`default_prompt.json`).
+- The code takes user inputs and updates the default inputs accordingly.
+- The code expects inputs like `folder_path`, `prompt_template_file`, `test_file_extension`, etc.
+
+### Outputs
+- The code generates a usage example based on the provided inputs.
+- It utilizes other steps like `CallCode2Prompt`, `ModifyCode`, and `PR` to create and process the example.
+- The final output includes modified code files and information for creating a pull request.

patchwork/patchflows/GenerateCodeUsageExample/__init__.py

@@ -0,0 +1,15 @@
+[
+    {
+        "id": "GenerateUsageExample",
+        "prompts": [
+            {
+                "role": "system",
+                "content": "You are a skilled technical writer specializing in creating concise, clear, and runnable usage examples for libraries, frameworks, and projects. Users will provide a description of the code or project, and you will generate examples that demonstrate practical use cases. Ensure examples are well-commented and runnable, with no extra explanation or formatting outside of the example code itself."
+            },
+            {
+                "role": "user",
+                "content": "Description: {{fullContent}}"
+            }
+        ]
+    }
+]

patchwork/patchflows/GenerateCodeUsageExample/default_prompt.json

@@ -0,0 +1,25 @@
+# CallLLM Inputs
+# openai_api_key: required-for-chatgpt
+# google_api_key: required-for-gemini
+# model: gpt-4o
+# client_base_url: https://api.openai.com/v1
+# Example HF model
+# client_base_url: https://api-inference.huggingface.co/models/codellama/CodeLlama-70b-Instruct-hf/v1
+# model: codellama/CodeLlama-70b-Instruct-hf
+# model_temperature: 0.2
+# model_top_p: 0.95
+# model_max_tokens: 2000
+
+# folder_path : path/to/folder/with/class
+
+# Default value
+test_file_extension : py
+
+# CommitChanges Inputs
+disable_branch: false
+
+# CreatePR Inputs
+disable_pr: false
+force_pr_creation: true
+# github_api_key: required-for-github-scm
+# gitlab_api_key: required-for-gitlab-scm

patchwork/patchflows/GenerateCodeUsageExample/defaults.yml

@@ -6,6 +6,8 @@
 from .GenerateUnitTests.GenerateUnitTests import GenerateUnitTests
 from .PRReview.PRReview import PRReview
 from .ResolveIssue.ResolveIssue import ResolveIssue
+from .GenerateUnitTests.GenerateUnitTests import GenerateUnitTests
+from .GenerateCodeUsageExample.GenerateCodeUsageExample import GenerateCodeUsageExample
 from .SonarFix.SonarFix import SonarFix
 
 __all__ = [
@@ -17,5 +19,7 @@
     "GenerateDocstring",
     "GenerateUnitTests",
     "GenerateDiagram",
+    "GenerateCodeUsageExample",
     "SonarFix",
 ]
+