versionhq 1.1.6.4__tar.gz → 1.1.7.1__tar.gz

{versionhq-1.1.6.4 → versionhq-1.1.7.1}/.github/workflows/publish.yml

@@ -18,7 +18,7 @@ jobs:
         uses: astral-sh/setup-uv@v4
         with:
           version: "0.5.11"
-  
+
       - name: Build release distributions
         run: |
           uv venv --python=python3.13.1
@@ -37,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
     needs:
       - release-build
-      
+
     permissions:
       id-token: write
 
@@ -60,4 +60,3 @@ jobs:
           verbose: true
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}
-    

versionhq-1.1.7.1/.github/workflows/run_tests.yml

@@ -0,0 +1,34 @@
+name: Run Tests
+
+on: [pull_request, push]
+
+permissions:
+  contents: write
+
+env:
+  LITELLM_API_KEY: ${{ secrets.LITELLM_API_KEY }}
+  OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+
+jobs:
+  run_test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "0.5.11"
+
+      - name: Set up the project
+        run: |
+          uv venv --python=python3.13.1
+          source .venv/bin/activate
+          uv pip install --upgrade pip pytest
+          uv pip install -r requirements.txt
+
+      - name: Run tests
+        run: uv run pytest tests -vv --cache-clear

{versionhq-1.1.6.4 → versionhq-1.1.7.1}/.gitignore

@@ -1,5 +1,4 @@
-publish.yml
-python_publish*
+knowledge/
 
 composio.py
 memo.txt
@@ -7,12 +6,16 @@ memo.txt
 dist/
 build/
 .pypirc
+uploads/
+sample_dataset/
+*egg-info/
+
 __pycache__/
 .ruff_cache/
+.pytest_cache/
+
 .DS_Store
 .vscode
+
 .env
 .venv/
-uploads/
-sample_dataset/
-*egg-info/

{versionhq-1.1.6.4 → versionhq-1.1.7.1}/.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
-    # -   id: trailing-whitespace
+    -   id: trailing-whitespace
     -   id: check-added-large-files
         args: ['--maxkb=100']
     -   id: check-json

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: versionhq
-Version: 1.1.6.4
+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.13.1-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)
@@ -111,7 +111,7 @@ The `agent` is model agnostic. The default model is set Chat GTP 4o. We ask the
 Multiple `agents` can form a `team` to complete complex tasks together.
 
 **1. Analysis**
-- Professional `agents` handle the analysis `tasks` on each client, customer, and product. 
+- Professional `agents` handle the analysis `tasks` on each client, customer, and product.
 
 **2. Messaging Workflow Creation**
 - Several `teams` receive the analysis and design initial messaging workflow with several layers.
@@ -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
 
@@ -166,10 +213,10 @@ src/
 │      └── ...
 │
 └──tests/
-      └── cli/   
+      └── cli/
       └── team/
       └── ...
-      │        
+      │
       └── uploads/    # Uploaded files for the project
 
 ```
@@ -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
@@ -239,13 +267,17 @@ For more details:
 
 4. Test the features using the `tests` directory.
 
-   - Add a file to the `tests` directory.
+   - Add a test function to respective components in the `tests` directory.
+   - Add your `LITELLM_API_KEY` and `OPENAI_API_KEY` to the Github `repository secrets` @ settings > secrets & variables > Actions.
    - Run a test.
       ```
-      uv run <your file name>
+      uv run pytest tests -vv
       ```
 
-   * All the `.py` files' names in the `tests` have to be ended with `_test.py`.
+   **pytest**
+
+   * When adding a new file to `tests`, name the file ended with `_test.py`.
+   * When adding a new feature to the file, name the feature started with `test_`.
 
 5. Pull the latest version of source code from the main branch (`git pull origin main`) *Address conflicts if any.
 6. Commit your changes (`git add .` / `git commit -m 'Add your-amazing-feature'`)
@@ -321,9 +353,10 @@ Common issues and solutions:
 - API key errors: Ensure all API keys in the `.env` file are correct and up to date. Make sure to add `load_dotenv()` on the top of the python file to apply the latest environment values.
 - Database connection issues: Check if the Chroma DB is properly initialized and accessible.
 - Memory errors: If processing large contracts, you may need to increase the available memory for the Python process.
-- Issues related to dependencies:`rm -rf .venv uv.lock`, `uv cache clean`  and run `uv run pip install -r requirements.txt -v`.
+- Issues related to dependencies: `rm -rf uv.lock`, `uv cache clean`, `uv venv`, and run `uv pip install -r requirements.txt -v`.
 - Issues related to the AI agents or RAG system: Check the `output.log` file for detailed error messages and stack traces.
 - Issues related to `Python quit unexpectedly`: Check [this stackoverflow article](https://stackoverflow.com/questions/59888499/macos-catalina-python-quit-unexpectedly-error).
+- `reportMissingImports` error from pyright after installing the package: This might occur when installing new libraries while VSCode is running. Open the command pallete (ctrl + shift + p) and run the Python: Restart language server task.
 
 <hr />
 
@@ -354,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.6.4 → 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.13.1-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)
@@ -59,7 +59,7 @@ The `agent` is model agnostic. The default model is set Chat GTP 4o. We ask the
 Multiple `agents` can form a `team` to complete complex tasks together.
 
 **1. Analysis**
-- Professional `agents` handle the analysis `tasks` on each client, customer, and product. 
+- Professional `agents` handle the analysis `tasks` on each client, customer, and product.
 
 **2. Messaging Workflow Creation**
 - Several `teams` receive the analysis and design initial messaging workflow with several layers.
@@ -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
 
@@ -114,10 +161,10 @@ src/
 │      └── ...
 │
 └──tests/
-      └── cli/   
+      └── cli/
       └── team/
       └── ...
-      │        
+      │
       └── uploads/    # Uploaded files for the project
 
 ```
@@ -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
@@ -187,13 +215,17 @@ For more details:
 
 4. Test the features using the `tests` directory.
 
-   - Add a file to the `tests` directory.
+   - Add a test function to respective components in the `tests` directory.
+   - Add your `LITELLM_API_KEY` and `OPENAI_API_KEY` to the Github `repository secrets` @ settings > secrets & variables > Actions.
    - Run a test.
       ```
-      uv run <your file name>
+      uv run pytest tests -vv
       ```
 
-   * All the `.py` files' names in the `tests` have to be ended with `_test.py`.
+   **pytest**
+
+   * When adding a new file to `tests`, name the file ended with `_test.py`.
+   * When adding a new feature to the file, name the feature started with `test_`.
 
 5. Pull the latest version of source code from the main branch (`git pull origin main`) *Address conflicts if any.
 6. Commit your changes (`git add .` / `git commit -m 'Add your-amazing-feature'`)
@@ -269,9 +301,10 @@ Common issues and solutions:
 - API key errors: Ensure all API keys in the `.env` file are correct and up to date. Make sure to add `load_dotenv()` on the top of the python file to apply the latest environment values.
 - Database connection issues: Check if the Chroma DB is properly initialized and accessible.
 - Memory errors: If processing large contracts, you may need to increase the available memory for the Python process.
-- Issues related to dependencies:`rm -rf .venv uv.lock`, `uv cache clean`  and run `uv run pip install -r requirements.txt -v`.
+- Issues related to dependencies: `rm -rf uv.lock`, `uv cache clean`, `uv venv`, and run `uv pip install -r requirements.txt -v`.
 - Issues related to the AI agents or RAG system: Check the `output.log` file for detailed error messages and stack traces.
 - Issues related to `Python quit unexpectedly`: Check [this stackoverflow article](https://stackoverflow.com/questions/59888499/macos-catalina-python-quit-unexpectedly-error).
+- `reportMissingImports` error from pyright after installing the package: This might occur when installing new libraries while VSCode is running. Open the command pallete (ctrl + shift + p) and run the Python: Restart language server task.
 
 <hr />
 
@@ -302,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.6.4 → versionhq-1.1.7.1}/pyproject.toml

@@ -15,7 +15,7 @@ exclude = ["test*", "__pycache__"]
 
 [project]
 name = "versionhq"
-version = "1.1.6.4"
+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"
@@ -58,15 +58,10 @@ dev-dependencies = [
   "python-dotenv>=1.0.0",
   "black",
   "bandit",
-  "twine"
+  "twine",
+  "pytest>=8.3.4",
 ]
 
-[tool.black]
-line-length = 88
-
-[tool.isort]
-profile = "black"
-
 [tool.uv.workspace]
 members = ["krik8235"]
 
@@ -75,3 +70,11 @@ ignore_missing_imports = true
 
 [tool.bandit]
 exclude_dirs = [""]
+
+
+[tool.pytest.ini_options]
+filterwarnings = "ignore"
+minversion = "8.0"
+addopts = "-v -ra -q"
+log_cli = true
+log_cli_level = "INFO"

{versionhq-1.1.6.4 → 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.6.4"
+__version__ = "1.1.7.1"
 __all__ = [
     "Agent",
     "Customer",

{versionhq-1.1.6.4 → versionhq-1.1.7.1}/src/versionhq/_utils/usage_metrics.py

@@ -7,18 +7,10 @@ class UsageMetrics(BaseModel):
     """
 
     total_tokens: int = Field(default=0, description="Total number of tokens used")
-    prompt_tokens: int = Field(
-        default=0, description="Number of tokens used in prompts"
-    )
-    cached_prompt_tokens: int = Field(
-        default=0, description="Number of cached prompt tokens used"
-    )
-    completion_tokens: int = Field(
-        default=0, description="Number of tokens used in completions"
-    )
-    successful_requests: int = Field(
-        default=0, description="Number of successful requests made"
-    )
+    prompt_tokens: int = Field(default=0, description="Number of tokens used in prompts")
+    cached_prompt_tokens: int = Field(default=0, description="Number of cached prompt tokens used")
+    completion_tokens: int = Field(default=0, description="Number of tokens used in completions")
+    successful_requests: int = Field(default=0, description="Number of successful requests made")
 
     def add_usage_metrics(self, usage_metrics: "UsageMetrics"):
         """

versionhq-1.1.7.1/src/versionhq/agent/TEMPLATES/Backstory.py

@@ -0,0 +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.
+"""