init

app.py

@@ -1,3 +1,17 @@
+# Copyright 2025 Akihito Miyazaki. team. All rights reserved.
+#
+# 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.
+
 import os
 
 import gradio as gr
@@ -6,15 +20,28 @@ from smolagents import CodeAgent, tool
 from linear_api_utils import execute_query
 from sleep_per_last_token_model import SleepPerLastTokenModelLiteLLM
 
-# .env
+# if use .env need these lines HF_TOKEN is optional
 """
 LINEAR_API_KEY="lin_api_***"
-HF_TOKEN = "hf_***"
 GROQ_API_KEY = "gsk_***"
+HF_TOKEN = "hf_***"
 """
 
 
 def get_env_value(key, is_value_error_on_null=True):
+    """
+    Gets an environment variable's value, loading from .env if needed.
+
+    Args:
+        key (str): Environment variable name.
+        is_value_error_on_null (bool): Raise ValueError if not found (default: True).
+
+    Returns:
+        str: Environment variable value.
+
+    Raises:
+        ValueError: If `key` is not found and `is_value_error_on_null` is True.
+    """
     value = os.getenv(key)
     if value is None:
         from dotenv import load_dotenv
@@ -44,6 +71,19 @@ model_id = "groq/llama3-8b-8192"
 
 
 def add_comment(issue_id, model_name, comment):
+    """
+    Add comment to an issue.
+
+
+    Args:
+        issue_id (str): Issue ID.
+        model_name (str): Model name added as title.
+        comment (str): Comment text.
+
+
+    Returns:
+        str: query result json.
+    """
     comment = comment.replace('"', '\\"').replace("\n", "\\n")  # escape doublequote
     # header = f"<!---\\n start-ai-comment({model_name}) \\n--->\\n"
     header = f"[ ](start-ai-comment:{model_name})\\n"
@@ -71,6 +111,12 @@ issue_id = None
 
 
 def change_state_reviewing():
+    """
+    Change the state of an issue to "Reviewing".
+
+    Returns:
+        None
+    """
     get_state_query_text = """
     query Sate{
     workflowStates(filter:{team:{id:{eq:"%s"}}}){
@@ -161,6 +207,12 @@ def get_todo_issue() -> str:
 
 
 def generate_agent():
+    """
+    Generate an agent.
+
+    Returns:
+        An agent.
+    """
     model = SleepPerLastTokenModelLiteLLM(
         max_tokens=250,
         temperature=0.5,
@@ -185,6 +237,15 @@ team_id = None
 
 
 def update_text():
+    """
+    Get the Todo issue and generate an agent.
+    agent solve the issue and return text to Gradio outputs
+
+    Returns:
+        A string describing the current issue.
+        A string describing the agent advice.
+    """
+
     def get_team_id(team_name):
         teams_text = """
     query Teams {
@@ -221,18 +282,23 @@ Finally, return the result of solving the Todo.
         """
     )
 
-    add_comment(issue_id, model_id, agent_text)
-    change_state_reviewing()
-    #    return "", ""
+    # If you duplicate space uncomment below
+    # add_comment(issue_id, model_id, agent_text)
+    # change_state_reviewing()
 
     return issue_text, agent_text
 
 
 with gr.Blocks() as demo:
-    gr.HTML("""<h1>Linear.app API and smolagents demo</h1>
-            <h2>Prepare</h2>
+    gr.HTML("""
+            <h1>Initial API-Based Smolagents and Linear.app Integration Example</h1>
+<p>Large language models, like 70B parameter models, can often readily utilize tools such as <code>add_comment</code> or <code>change_state</code>, potentially handling multiple issues concurrently.</p>
+<p>However, smaller models may require repeated calls to a tool or even fail to utilize it entirely.</p>
+<p>Therefore, this initial example focuses on the <code>get_todo_issue()</code> tool.</p>
+<h2>Post-Duplication/Cloning Instructions</h2>
             <p>Need Linear.app acount and api key</a>
-            <p>Remember team name and add "Reviewing" State<p> 
+            <p>change script team name to your team name,add "Reviewing" State in your linear.app team setting<p>
+            <p>comment out add_comment(),change_state_reviewing()</p> 
             """)
     with gr.Row():
         with gr.Column():
@@ -245,10 +311,10 @@ with gr.Blocks() as demo:
             output = gr.Markdown("agent result")
         demo.load(update_text, inputs=None, outputs=[issue, output])
 
-    #
+    # for manual solve
     # bt = gr.Button("Next Todo")
     # bt.click(update_text, inputs=None, outputs=[issue, output])
 
 
-if __name__ == "__main__":  # without main call twice
+if __name__ == "__main__":  # without main call demo called twice
     demo.launch()