versionhq 1.1.6.3__tar.gz → 1.1.7.0__tar.gz

{versionhq-1.1.6.3 → versionhq-1.1.7.0}/.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.0/.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.3 → versionhq-1.1.7.0}/.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.3 → versionhq-1.1.7.0}/.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.3 → versionhq-1.1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: versionhq
-Version: 1.1.6.3
+Version: 1.1.7.0
 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,7 +52,8 @@ Requires-Dist: wheel>=0.45.1
 
 # Overview
 
-![python ver](https://img.shields.io/badge/Python-3.13.1-blue) ![pyenv ver](https://img.shields.io/badge/pyenv-2.4.23-orange)
+![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)
 
 
 An LLM orchestration frameworks for multi-agent systems with RAG to autopilot outbound workflows.
@@ -64,10 +65,10 @@ Messaging workflows are created at individual level, and will be deployed on thi
 
 **Visit:**
 
-- Marketing:   [Landing page](https://home.versi0n.io)
-- Client app:  [Production](https://versi0n.io/)
-- Backend:     [Orchestration + multi-agent RAG system](https://github.com/versionHQ/multi-agent-system)
-- Test CI:     [Test client app (React)](https://github.com/versionHQ/test-client-app)
+- [Landing page](https://home.versi0n.io)
+- [Client app](https://versi0n.io/)
+- [Orchestration frameworks](https://github.com/versionHQ/multi-agent-system)
+- [Test client app](https://github.com/versionHQ/test-client-app)
 
 
 ## Mindmap
@@ -75,7 +76,7 @@ Messaging workflows are created at individual level, and will be deployed on thi
 LLM-powered `agent`s and `team`s use `tool`s and their own knowledge to complete the `task` given by the client or the system.
 
 <p align="center">
-   <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1733556715/pj_m_home/urwte15at3h0dr8mdlyo.png" alt="mindmap" width="1000">
+   <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1733556715/pj_m_home/urwte15at3h0dr8mdlyo.png" alt="mindmap" width="400">
 </p>
 
 <hr />
@@ -89,8 +90,7 @@ LLM-powered `agent`s and `team`s use `tool`s and their own knowledge to complete
 - [Project Structure](#project-structure)
 - [Setup](#setup)
 - [Usage](#usage)
-- [Installing as a Package Module (Alpha)](#installing-as-a-package-module-alpha)
-- [Contributing & Customizing](#contributing--customizing)
+- [Contributing](#contributing)
   - [Customizing AI Agents](#customizing-ai-agents)
   - [Modifying RAG Functionality](#modifying-rag-functionality)
   - [Package Management with uv](#package-management-with-uv)
@@ -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.
@@ -122,6 +122,8 @@ Multiple `agents` can form a `team` to complete complex tasks together.
 - Responsible `agents` or `teams` autopilot executing and refining the messaging workflow.
 
 
+<hr />
+
 ## Technologies Used
 **Schema, Database, Data Validation**
    - [Pydantic](https://docs.pydantic.dev/latest/): Data validation and serialization library for Python
@@ -164,14 +166,16 @@ src/
 │      └── ...
 │
 └──tests/
-      └── cli/   
+      └── cli/
       └── team/
       └── ...
-      │        
+      │
       └── uploads/    # Uploaded files for the project
 
 ```
 
+<hr />
+
 ## Setup
 
 1. Install the `uv` package manager:
@@ -204,53 +208,67 @@ src/
    COMPOSIO_CLI_KEY=your-composio-cli-key
    ```
 
-## Usage
+<hr />
 
-1. Add features.
+## Usage
 
-2. Test the features using the `tests` directory.
+1. Install `versionhq` package:
+```
+uv pip install versionhq
+```
 
-- Add a file to the `tests` directory.
-- Run a test.
+2. You can use the `versionhq` module in your Python app.
 ```
-uv run <your file name>
+from versionhq.agent.model import Agent
+agent = Agent(llm="your-llm", ...)
 ```
-* All the `.py` files' names in the `tests` have to be ended with `_test.py`.
 
+For more details:
 
-3. Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
-   ```
-   npm i
-   npm start
-   ```
-   The frontend will be available at `http://localhost:3000`.
+[PyPi package](https://pypi.org/project/versionhq/)
 
-4. `production` is available at `https://versi0n.io`. Currently, we are running beta.
+<hr />
 
+## Contributing
 
-## Installing as a Package Module (Alpha)
+1. Fork the repository
 
-1. Open another terminal, set your repository as root, and run
-```
-uv pip install git+https://github.com/versionHQ/multi-agent-system.git#egg=versionhq
-```
+2. Create your feature branch (`git checkout -b feature/your-amazing-feature`)
 
-2. You can use the `versionhq` module in your Python app.
-```
-from versionhq.agent.model import Agent
-agent = Agent(llm="your-llm"...)
-```
+3. Create amazing features
 
-## Contributing & Customizing
+4. Test the features using the `tests` directory.
 
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/your-amazing-feature`)
-3. Pull the latest version of source code from the main branch (`git pull origin main`) *Address conflicts if any.
-4. Commit your changes (`git add .` / `git commit -m 'Add your-amazing-feature'`)
-5. Push to the branch (`git push origin feature/your-amazing-feature`)
-6. Open a pull request
+   - 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 pytest tests -vv
+      ```
+
+   **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'`)
+7. Push to the branch (`git push origin feature/your-amazing-feature`)
+8. Open a pull request
+
+
+**Optional**
+* Flag with `#! REFINEME` for any improvements needed and `#! FIXME` for any errors.
+
+* Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
+   ```
+   npm i
+   npm start
+   ```
+   The frontend will be available at `http://localhost:3000`.
+
+* `production` is available at `https://versi0n.io`. Currently, we are running alpha test.
 
-0. Flag with `#! REFINEME` for any improvements and `#! FIXME` for any errors.
 
 
 ### Customizing AI Agents
@@ -299,16 +317,20 @@ Pre-commit hooks help maintain code quality by running checks for formatting, li
    git commit --no-verify -m "your-commit-message"
    ```
 
+<hr />
+
 ## Trouble Shooting
 
 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 />
 
 ## Frequently Asked Questions (FAQ)
 **Q. Where can I see if the agent is working?**

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

@@ -1,6 +1,7 @@
 # Overview
 
-![python ver](https://img.shields.io/badge/Python-3.13.1-blue) ![pyenv ver](https://img.shields.io/badge/pyenv-2.4.23-orange)
+![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)
 
 
 An LLM orchestration frameworks for multi-agent systems with RAG to autopilot outbound workflows.
@@ -12,10 +13,10 @@ Messaging workflows are created at individual level, and will be deployed on thi
 
 **Visit:**
 
-- Marketing:   [Landing page](https://home.versi0n.io)
-- Client app:  [Production](https://versi0n.io/)
-- Backend:     [Orchestration + multi-agent RAG system](https://github.com/versionHQ/multi-agent-system)
-- Test CI:     [Test client app (React)](https://github.com/versionHQ/test-client-app)
+- [Landing page](https://home.versi0n.io)
+- [Client app](https://versi0n.io/)
+- [Orchestration frameworks](https://github.com/versionHQ/multi-agent-system)
+- [Test client app](https://github.com/versionHQ/test-client-app)
 
 
 ## Mindmap
@@ -23,7 +24,7 @@ Messaging workflows are created at individual level, and will be deployed on thi
 LLM-powered `agent`s and `team`s use `tool`s and their own knowledge to complete the `task` given by the client or the system.
 
 <p align="center">
-   <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1733556715/pj_m_home/urwte15at3h0dr8mdlyo.png" alt="mindmap" width="1000">
+   <img src="https://res.cloudinary.com/dfeirxlea/image/upload/v1733556715/pj_m_home/urwte15at3h0dr8mdlyo.png" alt="mindmap" width="400">
 </p>
 
 <hr />
@@ -37,8 +38,7 @@ LLM-powered `agent`s and `team`s use `tool`s and their own knowledge to complete
 - [Project Structure](#project-structure)
 - [Setup](#setup)
 - [Usage](#usage)
-- [Installing as a Package Module (Alpha)](#installing-as-a-package-module-alpha)
-- [Contributing & Customizing](#contributing--customizing)
+- [Contributing](#contributing)
   - [Customizing AI Agents](#customizing-ai-agents)
   - [Modifying RAG Functionality](#modifying-rag-functionality)
   - [Package Management with uv](#package-management-with-uv)
@@ -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.
@@ -70,6 +70,8 @@ Multiple `agents` can form a `team` to complete complex tasks together.
 - Responsible `agents` or `teams` autopilot executing and refining the messaging workflow.
 
 
+<hr />
+
 ## Technologies Used
 **Schema, Database, Data Validation**
    - [Pydantic](https://docs.pydantic.dev/latest/): Data validation and serialization library for Python
@@ -112,14 +114,16 @@ src/
 │      └── ...
 │
 └──tests/
-      └── cli/   
+      └── cli/
       └── team/
       └── ...
-      │        
+      │
       └── uploads/    # Uploaded files for the project
 
 ```
 
+<hr />
+
 ## Setup
 
 1. Install the `uv` package manager:
@@ -152,53 +156,67 @@ src/
    COMPOSIO_CLI_KEY=your-composio-cli-key
    ```
 
-## Usage
+<hr />
 
-1. Add features.
+## Usage
 
-2. Test the features using the `tests` directory.
+1. Install `versionhq` package:
+```
+uv pip install versionhq
+```
 
-- Add a file to the `tests` directory.
-- Run a test.
+2. You can use the `versionhq` module in your Python app.
 ```
-uv run <your file name>
+from versionhq.agent.model import Agent
+agent = Agent(llm="your-llm", ...)
 ```
-* All the `.py` files' names in the `tests` have to be ended with `_test.py`.
 
+For more details:
 
-3. Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
-   ```
-   npm i
-   npm start
-   ```
-   The frontend will be available at `http://localhost:3000`.
+[PyPi package](https://pypi.org/project/versionhq/)
 
-4. `production` is available at `https://versi0n.io`. Currently, we are running beta.
+<hr />
 
+## Contributing
 
-## Installing as a Package Module (Alpha)
+1. Fork the repository
 
-1. Open another terminal, set your repository as root, and run
-```
-uv pip install git+https://github.com/versionHQ/multi-agent-system.git#egg=versionhq
-```
+2. Create your feature branch (`git checkout -b feature/your-amazing-feature`)
 
-2. You can use the `versionhq` module in your Python app.
-```
-from versionhq.agent.model import Agent
-agent = Agent(llm="your-llm"...)
-```
+3. Create amazing features
 
-## Contributing & Customizing
+4. Test the features using the `tests` directory.
 
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/your-amazing-feature`)
-3. Pull the latest version of source code from the main branch (`git pull origin main`) *Address conflicts if any.
-4. Commit your changes (`git add .` / `git commit -m 'Add your-amazing-feature'`)
-5. Push to the branch (`git push origin feature/your-amazing-feature`)
-6. Open a pull request
+   - 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 pytest tests -vv
+      ```
+
+   **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'`)
+7. Push to the branch (`git push origin feature/your-amazing-feature`)
+8. Open a pull request
+
+
+**Optional**
+* Flag with `#! REFINEME` for any improvements needed and `#! FIXME` for any errors.
+
+* Run a React demo app: [React demo app](https://github.com/versionHQ/test-client-app) to check it on the client endpoint.
+   ```
+   npm i
+   npm start
+   ```
+   The frontend will be available at `http://localhost:3000`.
+
+* `production` is available at `https://versi0n.io`. Currently, we are running alpha test.
 
-0. Flag with `#! REFINEME` for any improvements and `#! FIXME` for any errors.
 
 
 ### Customizing AI Agents
@@ -247,16 +265,20 @@ Pre-commit hooks help maintain code quality by running checks for formatting, li
    git commit --no-verify -m "your-commit-message"
    ```
 
+<hr />
+
 ## Trouble Shooting
 
 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 />
 
 ## Frequently Asked Questions (FAQ)
 **Q. Where can I see if the agent is working?**

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

@@ -15,7 +15,7 @@ exclude = ["test*", "__pycache__"]
 
 [project]
 name = "versionhq"
-version = "1.1.6.3"
+version = "1.1.7.0"
 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.0.0",
 ]
 
-[tool.black]
-line-length = 88
-
-[tool.isort]
-profile = "black"
-
 [tool.uv.workspace]
 members = ["krik8235"]
 
@@ -75,3 +70,7 @@ ignore_missing_imports = true
 
 [tool.bandit]
 exclude_dirs = [""]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra -q"

{versionhq-1.1.6.3 → versionhq-1.1.7.0}/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.3"
+__version__ = "1.1.7.0"
 __all__ = [
     "Agent",
     "Customer",

{versionhq-1.1.6.3 → versionhq-1.1.7.0}/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.0/src/versionhq/agent/TEMPLATES/Backstory.py

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