versionhq 1.1.7.0__tar.gz → 1.1.7.1__tar.gz

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/.github/workflows/run_tests.yml

@@ -31,4 +31,4 @@ jobs:
           uv pip install -r requirements.txt
 
       - name: Run tests
-        run: uv run pytest tests -vv  --cache-clear
+        run: uv run pytest tests -vv --cache-clear

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: versionhq
-Version: 1.1.7.0
+Version: 1.1.7.1
 Summary: LLM orchestration frameworks for model-agnostic AI agents that handle complex outbound workflows
 Author-email: Kuriko Iwai <kuriko@versi0n.io>
 License: MIT License
@@ -52,8 +52,7 @@ Requires-Dist: wheel>=0.45.1
 
 # Overview
 
-![MIT license](https://img.shields.io/badge/License-MIT-green) ![PyPi](https://img.shields.io/badge/pypi-v1.1.6.3-blue)
-![python ver](https://img.shields.io/badge/Python-3.12/3.13-purple) ![pyenv ver](https://img.shields.io/badge/pyenv-2.4.23-orange)
+![MIT license](https://img.shields.io/badge/License-MIT-green) [![Publisher](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml/badge.svg)](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml) ![PyPi](https://img.shields.io/badge/pypi-v1.1.7.0-blue) ![python ver](https://img.shields.io/badge/Python-3.12/3.13-purple) ![pyenv ver](https://img.shields.io/badge/pyenv-2.4.23-orange)
 
 
 An LLM orchestration frameworks for multi-agent systems with RAG to autopilot outbound workflows.
@@ -70,6 +69,7 @@ Messaging workflows are created at individual level, and will be deployed on thi
 - [Orchestration frameworks](https://github.com/versionHQ/multi-agent-system)
 - [Test client app](https://github.com/versionHQ/test-client-app)
 
+<hr />
 
 ## Mindmap
 
@@ -86,10 +86,10 @@ LLM-powered `agent`s and `team`s use `tool`s and their own knowledge to complete
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 - [Key Features](#key-features)
+- [Usage](#usage)
 - [Technologies Used](#technologies-used)
 - [Project Structure](#project-structure)
 - [Setup](#setup)
-- [Usage](#usage)
 - [Contributing](#contributing)
   - [Customizing AI Agents](#customizing-ai-agents)
   - [Modifying RAG Functionality](#modifying-rag-functionality)
@@ -121,6 +121,52 @@ Multiple `agents` can form a `team` to complete complex tasks together.
 **3. Autopiloting**
 - Responsible `agents` or `teams` autopilot executing and refining the messaging workflow.
 
+<hr />
+
+## Usage
+
+1. Install `versionhq` package:
+   ```
+   uv pip install versionhq
+   ```
+
+2. You can use the `versionhq` module in your Python app.
+
+   - **i.e.,** Make LLM-based agent execute the task and return JSON dict.
+
+   ```
+   from versionhq.agent.model import Agent
+   from versionhq.task.model import Task, ResponseField
+
+   agent = Agent(
+      role="demo",
+      goal="amazing project goal",
+      skillsets=["skill_1", "skill_2", ],
+      llm="llm-of-choice"
+   )
+
+   task = Task(
+      description="Amazing task",
+      expected_output_json=True,
+      expected_output_pydantic=False,
+      output_field_list=[
+         ResponseField(title="test1", type=str, required=True),
+         ResponseField(title="test2", type=list, required=True),
+      ],
+      context=["amazing context",],
+      tools=["amazing tool"],
+      callback=None,
+   )
+
+   res = task.execute_sync(agent=agent)
+
+   return res.to_dict()
+
+   ```
+
+For more details:
+
+[PyPi package](https://pypi.org/project/versionhq/)
 
 <hr />
 
@@ -145,6 +191,7 @@ Multiple `agents` can form a `team` to complete complex tasks together.
    - [pre-commit](https://pre-commit.com/): Manage and maintain pre-commit hooks
    - [setuptools](https://pypi.org/project/setuptools/): Build python modules
 
+<hr />
 
 ## Project Structure
 
@@ -210,25 +257,6 @@ src/
 
 <hr />
 
-## Usage
-
-1. Install `versionhq` package:
-```
-uv pip install versionhq
-```
-
-2. You can use the `versionhq` module in your Python app.
-```
-from versionhq.agent.model import Agent
-agent = Agent(llm="your-llm", ...)
-```
-
-For more details:
-
-[PyPi package](https://pypi.org/project/versionhq/)
-
-<hr />
-
 ## Contributing
 
 1. Fork the repository
@@ -359,17 +387,3 @@ Common issues and solutions:
 > **Simple tasks**: You have a straightforward, one-off task that doesn't require significant complexity or iteration.
 
 > **Human input**: You need to provide initial input or guidance to the agent, or you expect to review and refine the output.
-
-
-
-<--- Remaining tasks --->
-
-- llm handling - agent
-- more llms integration
-- simpler prompting
-- broader knowledge
-
-- utils - log
-- utils - time
-
-- end to end client app test

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/README.md

@@ -1,7 +1,6 @@
 # Overview
 
-![MIT license](https://img.shields.io/badge/License-MIT-green) ![PyPi](https://img.shields.io/badge/pypi-v1.1.6.3-blue)
-![python ver](https://img.shields.io/badge/Python-3.12/3.13-purple) ![pyenv ver](https://img.shields.io/badge/pyenv-2.4.23-orange)
+![MIT license](https://img.shields.io/badge/License-MIT-green) [![Publisher](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml/badge.svg)](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml) ![PyPi](https://img.shields.io/badge/pypi-v1.1.7.0-blue) ![python ver](https://img.shields.io/badge/Python-3.12/3.13-purple) ![pyenv ver](https://img.shields.io/badge/pyenv-2.4.23-orange)
 
 
 An LLM orchestration frameworks for multi-agent systems with RAG to autopilot outbound workflows.
@@ -18,6 +17,7 @@ Messaging workflows are created at individual level, and will be deployed on thi
 - [Orchestration frameworks](https://github.com/versionHQ/multi-agent-system)
 - [Test client app](https://github.com/versionHQ/test-client-app)
 
+<hr />
 
 ## Mindmap
 
@@ -34,10 +34,10 @@ LLM-powered `agent`s and `team`s use `tool`s and their own knowledge to complete
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 - [Key Features](#key-features)
+- [Usage](#usage)
 - [Technologies Used](#technologies-used)
 - [Project Structure](#project-structure)
 - [Setup](#setup)
-- [Usage](#usage)
 - [Contributing](#contributing)
   - [Customizing AI Agents](#customizing-ai-agents)
   - [Modifying RAG Functionality](#modifying-rag-functionality)
@@ -69,6 +69,52 @@ Multiple `agents` can form a `team` to complete complex tasks together.
 **3. Autopiloting**
 - Responsible `agents` or `teams` autopilot executing and refining the messaging workflow.
 
+<hr />
+
+## Usage
+
+1. Install `versionhq` package:
+   ```
+   uv pip install versionhq
+   ```
+
+2. You can use the `versionhq` module in your Python app.
+
+   - **i.e.,** Make LLM-based agent execute the task and return JSON dict.
+
+   ```
+   from versionhq.agent.model import Agent
+   from versionhq.task.model import Task, ResponseField
+
+   agent = Agent(
+      role="demo",
+      goal="amazing project goal",
+      skillsets=["skill_1", "skill_2", ],
+      llm="llm-of-choice"
+   )
+
+   task = Task(
+      description="Amazing task",
+      expected_output_json=True,
+      expected_output_pydantic=False,
+      output_field_list=[
+         ResponseField(title="test1", type=str, required=True),
+         ResponseField(title="test2", type=list, required=True),
+      ],
+      context=["amazing context",],
+      tools=["amazing tool"],
+      callback=None,
+   )
+
+   res = task.execute_sync(agent=agent)
+
+   return res.to_dict()
+
+   ```
+
+For more details:
+
+[PyPi package](https://pypi.org/project/versionhq/)
 
 <hr />
 
@@ -93,6 +139,7 @@ Multiple `agents` can form a `team` to complete complex tasks together.
    - [pre-commit](https://pre-commit.com/): Manage and maintain pre-commit hooks
    - [setuptools](https://pypi.org/project/setuptools/): Build python modules
 
+<hr />
 
 ## Project Structure
 
@@ -158,25 +205,6 @@ src/
 
 <hr />
 
-## Usage
-
-1. Install `versionhq` package:
-```
-uv pip install versionhq
-```
-
-2. You can use the `versionhq` module in your Python app.
-```
-from versionhq.agent.model import Agent
-agent = Agent(llm="your-llm", ...)
-```
-
-For more details:
-
-[PyPi package](https://pypi.org/project/versionhq/)
-
-<hr />
-
 ## Contributing
 
 1. Fork the repository
@@ -307,17 +335,3 @@ Common issues and solutions:
 > **Simple tasks**: You have a straightforward, one-off task that doesn't require significant complexity or iteration.
 
 > **Human input**: You need to provide initial input or guidance to the agent, or you expect to review and refine the output.
-
-
-
-<--- Remaining tasks --->
-
-- llm handling - agent
-- more llms integration
-- simpler prompting
-- broader knowledge
-
-- utils - log
-- utils - time
-
-- end to end client app test

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/pyproject.toml

@@ -15,7 +15,7 @@ exclude = ["test*", "__pycache__"]
 
 [project]
 name = "versionhq"
-version = "1.1.7.0"
+version = "1.1.7.1"
 authors = [{ name = "Kuriko Iwai", email = "kuriko@versi0n.io" }]
 description = "LLM orchestration frameworks for model-agnostic AI agents that handle complex outbound workflows"
 readme = "README.md"
@@ -59,7 +59,7 @@ dev-dependencies = [
   "black",
   "bandit",
   "twine",
-  "pytest>=8.0.0",
+  "pytest>=8.3.4",
 ]
 
 [tool.uv.workspace]
@@ -71,6 +71,10 @@ ignore_missing_imports = true
 [tool.bandit]
 exclude_dirs = [""]
 
+
 [tool.pytest.ini_options]
-minversion = "6.0"
-addopts = "-ra -q"
+filterwarnings = "ignore"
+minversion = "8.0"
+addopts = "-v -ra -q"
+log_cli = true
+log_cli_level = "INFO"

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/src/versionhq/__init__.py

@@ -17,7 +17,7 @@ from versionhq.team.model import Team, TeamOutput
 from versionhq.tool.model import Tool
 
 
-__version__ = "1.1.7.0"
+__version__ = "1.1.7.1"
 __all__ = [
     "Agent",
     "Customer",

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/src/versionhq/agent/TEMPLATES/Backstory.py

@@ -1,7 +1,3 @@
 BACKSTORY="""You are a {role} with deep understanding of {knowledge} and highly skilled in {skillsets}.
 You have access to call the RAG tools that can {rag_tool_overview}. By leveraging these tools, your knowledge, and skillsets, you can identify competitive strategies that have been proven effective to achieve the goal: {goal}. Take these into consideration, create innovative solutions.
 """
-
-
-# developing strategies to improve cohort retention and customer lifetime value
-# ingest past successful campaigns

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/src/versionhq/agent/model.py

@@ -367,8 +367,8 @@ class Agent(ABC, BaseModel):
         """
 
         task_prompt = task.prompt()
-        # if context:
-        #     task_prompt = self.i18n.slice("task_with_context").format(task=task_prompt, context=context)
+        if context:
+            task_prompt += context
 
         tool_results = []
         if task.tools_called:

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/src/versionhq/task/model.py

@@ -18,21 +18,44 @@ class ResponseField(BaseModel):
     """
     Field class to use in the response schema for the JSON response.
     """
+
     title: str = Field(default=None)
     type: Type = Field(default=str)
     required: bool = Field(default=True)
 
+
     def _annotate(self, value: Any) -> Annotated:
         """
         Address `create_model`
         """
         return Annotated[self.type, value] if isinstance(value, self.type) else Annotated[str, str(value)]
 
+
+    def _convert(self, value: Any) -> Any:
+        try:
+            if self.type is Any:
+                pass
+            elif self.type is int:
+                return int(value)
+            elif self.type is float:
+                return float(value)
+            elif self.type is list or self.type is dict:
+                return json.loads(value)
+            else:
+                return value
+        except:
+            return value
+
+
     def create_pydantic_model(self, result: Dict, base_model: Union[BaseModel | Any]) -> Any:
         for k, v in result.items():
-            if k is not self.title or type(v) is not self.type:
+            if k is not self.title:
                 pass
-            setattr(base_model, k, v)
+            elif type(v) is not self.type:
+                v = self._convert(v)
+                setattr(base_model, k, v)
+            else:
+                setattr(base_model, k, v)
         return base_model
 
 
@@ -43,12 +66,14 @@ class AgentOutput(BaseModel):
     """
     customer_id: str = Field(default=None, max_length=126, description="customer uuid")
     customer_analysis: str = Field(default=None, max_length=256, description="analysis of the customer")
-    business_overview: str = Field(default=None,max_length=256,description="analysis of the client's business")
-    cohort_timeframe: int = Field(default=None,max_length=256,description="Suitable cohort timeframe in days")
+    product_overview: str = Field(default=None, max_length=256, description="analysis of the client's business")
+    usp: str = Field()
+    cohort_timeframe: int = Field(default=None, max_length=256, description="suitable cohort timeframe in days")
     kpi_metrics: List[str] = Field(default=list, description="Ideal KPIs to be tracked")
     assumptions: List[Dict[str, Any]] = Field(default=list, description="assumptions to test")
 
 
+
 class TaskOutput(BaseModel):
     """
     Store the final output of the task in TaskOutput class.
@@ -57,8 +82,8 @@ class TaskOutput(BaseModel):
 
     task_id: UUID4 = Field(default_factory=uuid.uuid4, frozen=True, description="store Task ID")
     raw: str = Field(default="", description="Raw output of the task")
-    pydantic: Optional[Any] = Field(default=None, description="`raw` converted to the abs. pydantic model")
     json_dict: Union[Dict[str, Any]] = Field(default=None, description="`raw` converted to dictionary")
+    pydantic: Optional[Any] = Field(default=None, description="`raw` converted to the abs. pydantic model")
 
     def __str__(self) -> str:
         return str(self.pydantic) if self.pydantic else str(self.json_dict) if self.json_dict else self.raw
@@ -75,16 +100,31 @@ class TaskOutput(BaseModel):
             )
         return json.dumps(self.json_dict)
 
+
     def to_dict(self) -> Dict[str, Any]:
-        """Convert json_output and pydantic_output to a dictionary."""
+        """
+        Convert pydantic / raw output into dict and return the dict.
+        When we only have `raw` output, return `{ output: raw }` to avoid an error
+        """
+
         output_dict = {}
         if self.json_dict:
             output_dict.update(self.json_dict)
         elif self.pydantic:
             output_dict.update(self.pydantic.model_dump())
+        else:
+            output_dict.upate({ "output": self.raw })
         return output_dict
 
 
+    def context_prompting(self) -> str:
+        """
+        When the task is called as context, return its output in concise string to add it to the prompt
+        """
+        return json.dumps(self.json_dict) if self.json_dict else self.raw[0: 127]
+
+
+
 class Task(BaseModel):
     """
     Task to be executed by the agent or the team.
@@ -102,7 +142,10 @@ class Task(BaseModel):
     # output
     expected_output_json: bool = Field(default=True)
     expected_output_pydantic: bool = Field(default=False)
-    output_field_list: Optional[List[ResponseField]] = Field(default=[ResponseField(title="output")])
+    output_field_list: List[ResponseField] = Field(
+        default=[ResponseField(title="output", type=str, required=False)],
+        description="provide output key and data type. this will be cascaded to the agent via task.prompt()"
+    )
     output: Optional[TaskOutput] = Field(default=None, description="store the final task output in TaskOutput class")
 
     # task setup
@@ -123,18 +166,18 @@ class Task(BaseModel):
 
 
     @property
-    def output_prompt(self):
+    def output_prompt(self) -> str:
         """
         Draft prompts on the output format by converting `output_field_list` to dictionary.
         """
 
-        output_prompt, output_dict = "", dict()
+        output_prompt, output_formats_to_follow = "", dict()
         for item in self.output_field_list:
-            output_dict[item.title] = f"<Return your answer in {item.type.__name__}>"
+            output_formats_to_follow[item.title] = f"<Return your answer in {item.type.__name__}>"
 
         output_prompt = f"""
-        Your outputs STRICTLY follow the following format and should NOT contain any other irrevant elements that not specified in the following format:
-        {output_dict}
+Your outputs MUST adhere to the following format and should NOT include any irrelevant elements:
+{output_formats_to_follow}
         """
         return output_prompt
 
@@ -228,16 +271,25 @@ class Task(BaseModel):
         return self
 
 
-    def prompt(self, customer=str | None, product_overview=str | None) -> str:
+    def prompt(self, customer: str = None, product_overview: str = None) -> str:
         """
-        Format the task prompt.
+        Format the task prompt and cascade it to the agent.
+        When the task has context, add context prompting of all the tasks in the context.
+        When we have cusotmer/product info, add them to the prompt.
         """
-        task_slices = [
-            self.description,
-            f"Customer overview: {customer}",
-            f"Product overview: {product_overview}",
-            f"{self.output_prompt}",
-        ]
+
+        task_slices = [self.description, f"{self.output_prompt}"]
+
+        if self.context:
+            context_outputs = "\n".join([task.output.context_prompting() if hasattr(task, "output") else "" for task in self.context])
+            task_slices.insert(1,  f"Take the following context into consideration: {context_outputs}")
+
+        if customer:
+            task_slices.insert(1,  f"customer overview: {customer}")
+
+        if product_overview:
+            task_slices.insert(1, f"Product overview: {product_overview}")
+
         return "\n".join(task_slices)
 
 
@@ -273,10 +325,10 @@ class Task(BaseModel):
 
     def create_pydantic_output(self, output_json_dict: Dict[str, Any], raw_result: Any = None) -> Optional[Any]:
         """
-        Create pydantic output from the raw result.
+        Create pydantic output from the `raw` result.
         """
 
-        output_pydantic = None #! REFINEME
+        output_pydantic = None
         if isinstance(raw_result, BaseModel):
             output_pydantic = raw_result
 
@@ -285,8 +337,14 @@ class Task(BaseModel):
 
         else:
             output_pydantic = create_model("PydanticTaskOutput", __base__=BaseModel)
-            for item in self.output_field_list:
-                item.create_pydantic_model(result=output_json_dict, base_model=output_pydantic)
+            try:
+                for item in self.output_field_list:
+                    value = output_json_dict[item.title] if hasattr(output_json_dict, item.title) else None
+                    if value and type(value) is not item.type:
+                        value = item._convert(value)
+                    setattr(output_pydantic, item.title, value)
+            except:
+                setattr(output_pydantic, "output", output_json_dict)
 
         return output_pydantic
 
@@ -307,11 +365,19 @@ class Task(BaseModel):
             self.description = self._original_description.format(**inputs)
             # self.expected_output = self._original_expected_output.format(**inputs)
 
+
     # task execution
     def execute_sync(self, agent, context: Optional[str] = None) -> TaskOutput:
         """
         Execute the task synchronously.
+        When the task has context, make sure we have executed all the tasks in the context first.
         """
+
+        if self.context:
+            for task in self.context:
+                if task.output is None:
+                    task._execute_core(agent, context)
+
         return self._execute_core(agent, context)
 
 
@@ -341,12 +407,12 @@ class Task(BaseModel):
         """
 
         self.prompt_context = context
-        raw_result = agent.execute_task(task=self, context=context)
-        output_json_dict = self.create_json_output(raw_result=raw_result)
+        output_raw = agent.execute_task(task=self, context=context)
+        output_json_dict = self.create_json_output(raw_result=output_raw)
         output_pydantic = self.create_pydantic_output(output_json_dict=output_json_dict)
         task_output = TaskOutput(
             task_id=self.id,
-            raw=raw_result,
+            raw=output_raw,
             pydantic=output_pydantic,
             json_dict=output_json_dict
         )

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/src/versionhq/team/model.py

@@ -100,26 +100,27 @@ class TeamOutput(BaseModel):
 
     def to_dict(self) -> Dict[str, Any]:
         """
-        Convert json_output and pydantic_output to a dictionary.
+        Convert pydantic / raw output into dict and return the dict.
+        When we only have `raw` output, return `{ output: raw }` to avoid an error
         """
+
         output_dict = {}
         if self.json_dict:
             output_dict.update(self.json_dict)
         elif self.pydantic:
             output_dict.update(self.pydantic.model_dump())
         else:
-            output_dict.update({"output", self.raw})
+            output_dict.upate({ "output": self.raw })
         return output_dict
 
+
     def return_all_task_outputs(self) -> List[Dict[str, Any]]:
         res = [output.json_dict for output in self.task_output_list]
         return res
 
 
 class TeamMember(ABC, BaseModel):
-    agent: Agent | None = Field(
-        default=None, description="store the agent to be a member"
-    )
+    agent: Agent | None = Field(default=None, description="store the agent to be a member")
     is_manager: bool = Field(default=False)
     task: Task | None = Field(default=None)
 
@@ -164,9 +165,11 @@ class Team(BaseModel):
     execution_logs: List[Dict[str, Any]] = Field(default=[], description="list of execution logs for tasks")
     usage_metrics: Optional[UsageMetrics] = Field(default=None, description="usage metrics for all the llm executions")
 
+
     def __name__(self) -> str:
         return self.name if self.name is not None else self.id.__str__
 
+
     @property
     def key(self) -> str:
         source = [str(member.agent.id.__str__) for member in self.members] + [str(task.id.__str__) for task in self.tasks]
@@ -175,9 +178,7 @@ class Team(BaseModel):
 
     @property
     def manager_agent(self) -> Agent:
-        manager_agent = [
-            member.agent for member in self.members if member.is_manager == True
-        ]
+        manager_agent = [member.agent for member in self.members if member.is_manager == True]
         return manager_agent[0] if len(manager_agent) > 0 else None
 
 
@@ -251,7 +252,6 @@ class Team(BaseModel):
         """
         Every team member should have a task to handle.
         """
-
         if self.process == TaskHandlingProcess.sequential:
             for member in self.members:
                 if member.task is None:

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/src/versionhq.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: versionhq
-Version: 1.1.7.0
+Version: 1.1.7.1
 Summary: LLM orchestration frameworks for model-agnostic AI agents that handle complex outbound workflows
 Author-email: Kuriko Iwai <kuriko@versi0n.io>
 License: MIT License
@@ -52,8 +52,7 @@ Requires-Dist: wheel>=0.45.1
 
 # Overview
 
-![MIT license](https://img.shields.io/badge/License-MIT-green) ![PyPi](https://img.shields.io/badge/pypi-v1.1.6.3-blue)
-![python ver](https://img.shields.io/badge/Python-3.12/3.13-purple) ![pyenv ver](https://img.shields.io/badge/pyenv-2.4.23-orange)
+![MIT license](https://img.shields.io/badge/License-MIT-green) [![Publisher](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml/badge.svg)](https://github.com/versionHQ/multi-agent-system/actions/workflows/publish.yml) ![PyPi](https://img.shields.io/badge/pypi-v1.1.7.0-blue) ![python ver](https://img.shields.io/badge/Python-3.12/3.13-purple) ![pyenv ver](https://img.shields.io/badge/pyenv-2.4.23-orange)
 
 
 An LLM orchestration frameworks for multi-agent systems with RAG to autopilot outbound workflows.
@@ -70,6 +69,7 @@ Messaging workflows are created at individual level, and will be deployed on thi
 - [Orchestration frameworks](https://github.com/versionHQ/multi-agent-system)
 - [Test client app](https://github.com/versionHQ/test-client-app)
 
+<hr />
 
 ## Mindmap
 
@@ -86,10 +86,10 @@ LLM-powered `agent`s and `team`s use `tool`s and their own knowledge to complete
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 - [Key Features](#key-features)
+- [Usage](#usage)
 - [Technologies Used](#technologies-used)
 - [Project Structure](#project-structure)
 - [Setup](#setup)
-- [Usage](#usage)
 - [Contributing](#contributing)
   - [Customizing AI Agents](#customizing-ai-agents)
   - [Modifying RAG Functionality](#modifying-rag-functionality)
@@ -121,6 +121,52 @@ Multiple `agents` can form a `team` to complete complex tasks together.
 **3. Autopiloting**
 - Responsible `agents` or `teams` autopilot executing and refining the messaging workflow.
 
+<hr />
+
+## Usage
+
+1. Install `versionhq` package:
+   ```
+   uv pip install versionhq
+   ```
+
+2. You can use the `versionhq` module in your Python app.
+
+   - **i.e.,** Make LLM-based agent execute the task and return JSON dict.
+
+   ```
+   from versionhq.agent.model import Agent
+   from versionhq.task.model import Task, ResponseField
+
+   agent = Agent(
+      role="demo",
+      goal="amazing project goal",
+      skillsets=["skill_1", "skill_2", ],
+      llm="llm-of-choice"
+   )
+
+   task = Task(
+      description="Amazing task",
+      expected_output_json=True,
+      expected_output_pydantic=False,
+      output_field_list=[
+         ResponseField(title="test1", type=str, required=True),
+         ResponseField(title="test2", type=list, required=True),
+      ],
+      context=["amazing context",],
+      tools=["amazing tool"],
+      callback=None,
+   )
+
+   res = task.execute_sync(agent=agent)
+
+   return res.to_dict()
+
+   ```
+
+For more details:
+
+[PyPi package](https://pypi.org/project/versionhq/)
 
 <hr />
 
@@ -145,6 +191,7 @@ Multiple `agents` can form a `team` to complete complex tasks together.
    - [pre-commit](https://pre-commit.com/): Manage and maintain pre-commit hooks
    - [setuptools](https://pypi.org/project/setuptools/): Build python modules
 
+<hr />
 
 ## Project Structure
 
@@ -210,25 +257,6 @@ src/
 
 <hr />
 
-## Usage
-
-1. Install `versionhq` package:
-```
-uv pip install versionhq
-```
-
-2. You can use the `versionhq` module in your Python app.
-```
-from versionhq.agent.model import Agent
-agent = Agent(llm="your-llm", ...)
-```
-
-For more details:
-
-[PyPi package](https://pypi.org/project/versionhq/)
-
-<hr />
-
 ## Contributing
 
 1. Fork the repository
@@ -359,17 +387,3 @@ Common issues and solutions:
 > **Simple tasks**: You have a straightforward, one-off task that doesn't require significant complexity or iteration.
 
 > **Human input**: You need to provide initial input or guidance to the agent, or you expect to review and refine the output.
-
-
-
-<--- Remaining tasks --->
-
-- llm handling - agent
-- more llms integration
-- simpler prompting
-- broader knowledge
-
-- utils - log
-- utils - time
-
-- end to end client app test

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/tests/agent/agent_test.py

@@ -76,4 +76,4 @@ def test_build_agent_with_llm():
     assert agent.llm.api_key == LITELLM_API_KEY
     assert agent.tools == []
 
-# NEED TO ADD AGENTS WITH TOOLS
+# AGENTS WITH TOOLS

versionhq-1.1.7.1/tests/conftest.py

@@ -0,0 +1,3 @@
+from dotenv import load_dotenv
+
+load_dotenv(override=True)

versionhq-1.1.7.1/tests/task/task_test.py

@@ -0,0 +1,112 @@
+import os
+import pytest
+from typing import Union
+from versionhq.agent.model import Agent
+from versionhq.task.model import Task, ResponseField, TaskOutput, AgentOutput
+
+DEFAULT_MODEL_NAME = os.environ.get("LITELLM_MODEL_NAME", "gpt-3.5-turbo")
+LITELLM_API_KEY = os.environ.get("LITELLM_API_KEY")
+
+
+def test_sync_execute_task():
+    agent = Agent(
+        role="demo agent 000",
+        goal="My amazing goals",
+        backstory="My amazing backstory",
+        verbose=True,
+        llm=DEFAULT_MODEL_NAME,
+        max_tokens=3000,
+    )
+
+    task = Task(
+        description="Analyze the client's business model and define the optimal cohort timeframe.",
+        expected_output_json=True,
+        expected_output_pydantic=True,
+        output_field_list=[
+            ResponseField(title="test1", type=str, required=True),
+            ResponseField(title="test2", type=list, required=True),
+        ],
+        context=None,
+        callback=None,
+    )
+    res = task.execute_sync(agent=agent)
+
+    assert isinstance(res, TaskOutput)
+    assert res.task_id is task.id
+    assert res.raw is not None
+    assert isinstance(res.raw, str)
+    assert res.json_dict is not None
+    assert isinstance(res.json_dict, dict)
+    assert res.pydantic is not None
+
+    if hasattr(res.pydantic, "output"):
+        assert res.pydantic.output is not None
+    else:
+        assert hasattr(res.pydantic, "test1")
+        if res.pydantic.test1:
+            assert type(res.pydantic.test1) == str
+
+        assert hasattr(res.pydantic, "test2")
+        if res.pydantic.test2:
+            assert type(res.pydantic.test2) == list
+
+
+def test_sync_execute_task_with_context():
+    """
+    Use case = One agent handling multiple tasks sequentially using context set in the main task.
+    """
+
+    agent = Agent(
+        role="demo agent 001",
+        goal="My amazing goals",
+        backstory="My amazing backstory",
+        verbose=True,
+        llm=DEFAULT_MODEL_NAME,
+        max_tokens=3000,
+    )
+
+    sub_task = Task(
+        description="analyze the client's business model",
+        expected_output_json=True,
+        expected_output_pydantic=False,
+        output_field_list=[
+            ResponseField(title="result", type=str, required=True),
+        ]
+    )
+    main_task = Task(
+        description="Define the optimal cohort timeframe in days and target audience.",
+        expected_output_json=True,
+        expected_output_pydantic=True,
+        output_field_list=[
+            ResponseField(title="test1", type=int, required=True),
+            ResponseField(title="test2", type=str, required=True),
+        ],
+        context=[sub_task]
+    )
+    res = main_task.execute_sync(agent=agent)
+
+    assert isinstance(res, TaskOutput)
+    assert res.task_id is main_task.id
+    assert res.raw is not None
+    assert isinstance(res.raw, str)
+    assert res.json_dict is not None
+    assert isinstance(res.json_dict, dict)
+    assert res.pydantic is not None
+
+    if hasattr(res.pydantic, "output"):
+        assert res.pydantic.output is not None
+    else:
+        assert hasattr(res.pydantic, "test1")
+        if res.pydantic.test1:
+            assert type(res.pydantic.test1) == Union[int, str]
+
+        assert hasattr(res.pydantic, "test2")
+        if res.pydantic.test2:
+            assert type(res.pydantic.test2) == Union[list, str]
+
+    assert sub_task.output is not None
+    assert sub_task.output.json_dict is not None
+    assert "result" in main_task.prompt()
+
+
+# CALLBACKS, tools, FUTURE, ASYNC, CONDITIONAL, token usage

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/tests/team/team_test.py

@@ -11,7 +11,7 @@ MODEL_NAME = os.environ.get("LITELLM_MODEL_NAME", "gpt-3.5-turbo")
 
 def test_form_team():
     agent_a = Agent(
-        role="Demo Agent A",
+        role="agent a",
         goal="My amazing goals",
         backstory="My amazing backstory",
         verbose=True,
@@ -20,7 +20,7 @@ def test_form_team():
     )
 
     agent_b = Agent(
-        role="Demo Agent B-1",
+        role="agent b",
         goal="My amazing goals",
         verbose=True,
         llm=MODEL_NAME,
@@ -28,7 +28,7 @@ def test_form_team():
     )
 
     task_1 = Task(
-            description="Analyze the client's business model, target audience, and customer information and define the optimal cohort timeframe based on customer lifecycle and product usage patterns.",
+            description="Analyze the client's business model.",
             expected_output_json=True,
             output_field_list=[
                 ResponseField(title="test1", type=str, required=True),
@@ -41,7 +41,7 @@ def test_form_team():
         )
 
     task_2 = Task(
-        description="Amazing task description",
+        description="Define the cohort.",
         expected_output_json=True,
         expected_output_pydantic=True,
         output_field_list=[
@@ -72,7 +72,7 @@ def test_form_team():
 
 def test_form_team_without_leader():
     agent_a = Agent(
-        role="Demo Agent A",
+        role="agent a",
         goal="My amazing goals",
         backstory="My amazing backstory",
         verbose=True,
@@ -81,7 +81,7 @@ def test_form_team_without_leader():
     )
 
     agent_b = Agent(
-        role="Demo Agent B-1",
+        role="agent b",
         goal="My amazing goals",
         verbose=True,
         llm=MODEL_NAME,
@@ -89,7 +89,7 @@ def test_form_team_without_leader():
     )
 
     task_1 = Task(
-            description="Analyze the client's business model, target audience, and customer information and define the optimal cohort timeframe based on customer lifecycle and product usage patterns.",
+            description="Analyze the client's business model.",
             expected_output_json=True,
             output_field_list=[
                 ResponseField(title="test1", type=str, required=True),
@@ -102,7 +102,7 @@ def test_form_team_without_leader():
         )
 
     task_2 = Task(
-        description="Amazing task description",
+        description="Define the cohort.",
         expected_output_json=True,
         expected_output_pydantic=True,
         output_field_list=[
@@ -150,7 +150,7 @@ def test_kickoff_team_without_leader():
     )
 
     task_1 = Task(
-            description="Analyze the client's business model, target audience, and customer information and define the optimal cohort timeframe based on customer lifecycle and product usage patterns.",
+            description="Analyze the client's business model.",
             expected_output_json=True,
             output_field_list=[
                 ResponseField(title="test1", type=str, required=True),
@@ -163,7 +163,7 @@ def test_kickoff_team_without_leader():
         )
 
     task_2 = Task(
-        description="Amazing task description",
+        description="Define the cohort.",
         expected_output_json=True,
         expected_output_pydantic=True,
         output_field_list=[
@@ -198,8 +198,11 @@ def test_kickoff_team_without_leader():
     assert len(res_all) == 2
     for item in res_all:
         assert isinstance(item, dict)
-        assert "test1" in item
-        assert "test2" in item
+        if not hasattr(item, "output") or not hasattr(res_all, "output"):
+            assert "test1" in item
+            assert "test2" in item
+        else:
+            assert "output" in item
 
     assert isinstance(res.token_usage, UsageMetrics)
     assert res.token_usage.total_tokens == 0 # as we dont set token usage on agent

{versionhq-1.1.7.0 → versionhq-1.1.7.1}/uv.lock

@@ -1647,7 +1647,7 @@ wheels = [
 
 [[package]]
 name = "versionhq"
-version = "1.1.7.0"
+version = "1.1.7.1"
 source = { editable = "." }
 dependencies = [
     { name = "composio" },
@@ -1703,6 +1703,7 @@ dev = [
     { name = "mypy", specifier = ">=1.10.0" },
     { name = "pre-commit", specifier = ">=3.6.0" },
     { name = "pytest", specifier = ">=8.0.0" },
+    { name = "pytest", specifier = ">=8.3.4" },
     { name = "pytest-vcr", specifier = ">=1.0.2" },
     { name = "python-dotenv", specifier = ">=1.0.0" },
     { name = "twine" },

versionhq-1.1.7.0/tests/conftest.py

@@ -1,3 +0,0 @@
-from dotenv import load_dotenv
-
-load_result = load_dotenv(override=True)

versionhq-1.1.7.0/tests/task/task_test.py

@@ -1,46 +0,0 @@
-import os
-from typing import Type
-from pydantic import BaseModel
-from versionhq.agent.model import Agent
-from versionhq.task.model import Task, ResponseField, TaskOutput, AgentOutput
-
-MODEL_NAME = os.environ.get("LITELLM_MODEL_NAME", "gpt-3.5-turbo")
-
-
-def test_sync_execute_task():
-    agent_a = Agent(
-        role="Demo Agent A",
-        goal="My amazing goals",
-        backstory="My amazing backstory",
-        verbose=True,
-        llm=MODEL_NAME,
-        max_tokens=3000,
-    )
-
-    task = Task(
-        description="Analyze the client's business model, target audience, and customer information and define the optimal cohort timeframe based on customer lifecycle and product usage patterns.",
-        expected_output_json=True,
-        output_field_list=[
-            ResponseField(title="test1", type=str, required=True),
-            ResponseField(title="test2", type=list, required=True),
-        ],
-        expected_output_pydantic=True,
-        context=[],
-        tools=[],
-        callback=None,
-    )
-    res = task.execute_sync(agent=agent_a)
-
-    assert isinstance(res, TaskOutput)
-    assert res.task_id is task.id
-    assert res.raw is not None
-    assert isinstance(res.raw, str)
-    assert res.json_dict is not None
-    assert isinstance(res.json_dict, dict)
-    assert res.pydantic is not None
-    assert hasattr(res.pydantic, "test1")
-    assert type(res.pydantic.test1) == str
-    assert hasattr(res.pydantic, "test2")
-    assert type(res.pydantic.test2) == list
-
-# CALLBACKS, TASK HANDLED BY AGENTS WITH TOOLS, FUTURE, ASYNC, CONDITIONAL, token usage