jvcli 2.0.6__tar.gz → 2.0.8__tar.gz

{jvcli-2.0.6/jvcli.egg-info → jvcli-2.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: jvcli
-Version: 2.0.6
+Version: 2.0.8
 Summary: CLI tool for Jivas Package Repository
 Home-page: https://github.com/TrueSelph/jvcli
 Author: TrueSelph Inc.

{jvcli-2.0.6 → jvcli-2.0.8}/jvcli/__init__.py

@@ -4,5 +4,5 @@ jvcli package initialization.
 This package provides the CLI tool for Jivas Package Repository.
 """
 
-__version__ = "2.0.6"
+__version__ = "2.0.8"
 __supported__jivas__versions__ = ["2.0.0"]

{jvcli-2.0.6 → jvcli-2.0.8}/jvcli/api.py

@@ -57,13 +57,20 @@ class RegistryAPI:
 
     @staticmethod
     def get_package_info(
-        name: str, version: str = "", token: Optional[str] = None
+        name: str,
+        version: str = "",
+        token: Optional[str] = None,
+        api_key: Optional[str] = None,
     ) -> dict:
         """Get action info.yaml content as json"""
         endpoint = "info"
 
         try:
-            headers = {"Authorization": f"Bearer {token}"} if token else None
+            headers = {"Authorization": f"Bearer {token}"} if token else {}
+
+            if api_key:
+                headers["x-api-key"] = api_key
+
             data = {
                 "name": name,
                 "version": "" if version == "latest" else version,
@@ -91,12 +98,16 @@ class RegistryAPI:
         info: bool = False,
         suppress_error: bool = False,
         token: Optional[str] = None,
+        api_key: Optional[str] = None,
     ) -> dict:
         """Download a Jivas Package."""
         endpoint = "download"
 
         try:
-            headers = {"Authorization": f"Bearer {token}"} if token else None
+            headers = {"Authorization": f"Bearer {token}"} if token else {}
+
+            if api_key:
+                headers["x-api-key"] = api_key
 
             data = {
                 "name": name,
@@ -124,13 +135,20 @@ class RegistryAPI:
 
     @staticmethod
     def get_action_info(
-        name: str, version: str = "", token: Optional[str] = None
+        name: str,
+        version: str = "",
+        token: Optional[str] = None,
+        api_key: Optional[str] = None,
     ) -> dict:
         """Get action info.yaml content as json"""
         endpoint = "info"
 
         try:
-            headers = {"Authorization": f"Bearer {token}"} if token else None
+            headers = {"Authorization": f"Bearer {token}"} if token else {}
+
+            if api_key:
+                headers["x-api-key"] = api_key
+
             data = {
                 "name": name,
                 "version": "" if version == "latest" else version,

{jvcli-2.0.6 → jvcli-2.0.8}/jvcli/client/app.py

@@ -26,22 +26,38 @@ def login_form() -> None:
     """Render the login form and handle login logic."""
     login_url = f"{JIVAS_URL}/user/login"
 
-    with st.container(border=True):
-        st.header("Login")
+    st.write(os.environ.get("JIVAS_ENVIRONMENT"))
 
-        email = st.text_input("Email")
-        password = st.text_input("Password", type="password")
+    if os.environ.get("JIVAS_ENVIRONMENT") == "development":
+        email = os.environ.get("JIVAS_USER", "admin@jivas.com")
+        password = os.environ.get("JIVAS_PASSWORD", "password")
 
-        if st.button("Login"):
-            response = requests.post(
-                login_url, json={"email": email, "password": password}
-            )
+        response = requests.post(login_url, json={"email": email, "password": password})
+
+        if response.status_code == 200:
+            st.session_state.ROOT_ID = response.json()["user"]["root_id"]
+            st.session_state.TOKEN = response.json()["token"]
+            st.session_state.EXPIRATION = response.json()["user"]["expiration"]
+            st.rerun()
+
+    else:
+
+        with st.container(border=True):
+            st.header("Login")
+
+            email = st.text_input("Email")
+            password = st.text_input("Password", type="password")
+
+            if st.button("Login"):
+                response = requests.post(
+                    login_url, json={"email": email, "password": password}
+                )
 
-            if response.status_code == 200:
-                st.session_state.ROOT_ID = response.json()["user"]["root_id"]
-                st.session_state.TOKEN = response.json()["token"]
-                st.session_state.EXPIRATION = response.json()["user"]["expiration"]
-                st.rerun()
+                if response.status_code == 200:
+                    st.session_state.ROOT_ID = response.json()["user"]["root_id"]
+                    st.session_state.TOKEN = response.json()["token"]
+                    st.session_state.EXPIRATION = response.json()["user"]["expiration"]
+                    st.rerun()
 
 
 def main() -> None:

{jvcli-2.0.6 → jvcli-2.0.8}/jvcli/commands/startproject.py

@@ -33,7 +33,7 @@ def startproject(project_name: str, version: str) -> None:
         "tests": [],
         "actions": [],
         "daf": [],
-        "scripts": [],
+        "sh": [],
     }
 
     try:
@@ -44,18 +44,28 @@ def startproject(project_name: str, version: str) -> None:
         for folder in project_structure.keys():
             os.makedirs(os.path.join(project_name, folder), exist_ok=True)
 
-        # Copy template files from the selected version
-        for filename in ["main.jac", "globals.jac", "env.example"]:
-            template_file_path = os.path.join(template_path, filename)
-            if os.path.exists(template_file_path):
+        # Copy template files and folders from the selected version
+        for root, dirs, files in os.walk(template_path):
+            relative_path = os.path.relpath(root, template_path)
+            target_dir = os.path.join(project_name, relative_path)
+
+            # Create directories
+            for dir_name in dirs:
+                os.makedirs(os.path.join(target_dir, dir_name), exist_ok=True)
+
+            # Copy files
+            for file_name in files:
+                template_file_path = os.path.join(root, file_name)
+                target_file_path = os.path.join(target_dir, file_name)
+
                 with open(template_file_path, "r") as template_file:
                     contents = template_file.read()
 
                 # Write `.env` instead of `env.example`
-                target_filename = ".env" if filename == "env.example" else filename
-                with open(
-                    os.path.join(project_name, target_filename), "w"
-                ) as project_file:
+                if file_name == "env.example":
+                    target_file_path = os.path.join(target_dir, ".env")
+
+                with open(target_file_path, "w") as project_file:
                     project_file.write(contents)
 
         click.secho(

jvcli-2.0.8/jvcli/templates/2.0.0/project/README.md

@@ -0,0 +1,43 @@
+# Getting Started with JIVAS
+
+Welcome to your JIVAS AI project boilerplate!
+
+## Running Your JIVAS App
+
+To start your JIVAS app, execute the following command within this project folder:
+
+```sh
+sh sh/serve.sh
+```
+
+## Setting Up a Demo Agent
+
+To set up a demo agent, run the following command in another terminal:
+
+```sh
+sh sh/import_agent.sh
+```
+
+This will initialize JIVAS, download, and install a demo agent.
+
+## Accessing the JIVAS Manager
+
+Once the setup is complete, run the following command in its own terminal to access the JIVAS manager for configuring and chatting with your agent:
+
+```sh
+jvcli client launch
+```
+
+## Reflecting Changes to Agent Actions
+
+If you make any changes to the agent actions, run the following command to reinitialize all agents running within this JIVAS app:
+
+```sh
+sh sh/init.sh
+```
+
+## Logging In
+
+When the JIVAS manager loads, log in with the default JIVAS credentials found in your `.env` file.
+
+Happy building!

jvcli-2.0.8/jvcli/templates/2.0.0/project/actions/README.md

@@ -0,0 +1,41 @@
+# Custom Actions
+
+This directory is designated for custom or downloaded actions.
+
+## Instructions
+
+1. **Create Your Custom Actions**: Place your custom action scripts in this folder.
+2. **Naming Convention**: Use clear and descriptive names for your action files to ensure they are easily identifiable.
+3. **Permissions**: Ensure your scripts have the appropriate permissions to be executed.
+
+## Creating a Custom Action with jvcli
+
+To create a custom action using `jvcli`, follow these steps:
+
+1. **Run the Command**: Use the following command to create a new action:
+    ```sh
+    jvcli create action --name your_action_name --description "Your action description"
+    ```
+    Replace `your_action_name` with the desired name for your action in snake_case.
+
+2. **Options**: You can customize the creation process with various options:
+    - `--version`: Specify the version of the action. Default is `0.0.1`.
+    - `--jivas_version`: Specify the version of Jivas. Default is `2.0.0`.
+    - `--type`: Define the type of action (`action`, `interact_action`, or `vector_store_action`). Default is `action`.
+    - `--singleton`: Indicate if the action is singleton. Default is `True`.
+    - `--path`: Directory to create the action folder in. Default is `./actions`.
+    - `--namespace`: Namespace for the action. Defaults to the username in the token.
+
+3. **Example**:
+    ```sh
+    jvcli create action --name my_custom_action --description "This is a custom action" --type action
+    ```
+
+For more information, refer to the project's documentation.
+
+## Notes
+
+- Custom actions should be thoroughly tested before deployment.
+- Follow best practices for scripting and error handling.
+
+For more information, refer to the project's documentation.

jvcli-2.0.8/jvcli/templates/2.0.0/project/daf/README.md

@@ -0,0 +1,39 @@
+# Digital Agent Freight (DAF) Packages
+
+This directory is for your custom or downloaded Digital Agent Freight (DAF) packages. DAFs contain all configurations, knowledge, and memory snapshots for a JIVAS AI agent.
+
+## Instructions
+
+1. **Create Your DAF Packages**: Place your custom or downloaded DAF packages in this folder.
+2. **Naming Convention**: Use clear and descriptive names for your DAF packages to ensure they are easily identifiable.
+3. **Permissions**: Ensure your packages have the appropriate permissions to be accessed and executed.
+
+## Creating a Starter DAF Package with jvcli
+
+To create a new DAF package using `jvcli`, follow these steps:
+
+1. **Run the Command**: Use the following command to create a new DAF package:
+    ```sh
+    jvcli create agent --name your_agent_name --description "Your agent description"
+    ```
+    Replace `your_agent_name` with the desired name for your agent in snake_case.
+
+2. **Options**: You can customize the creation process with various options:
+    - `--version`: Specify the version of the agent. Default is `0.0.1`.
+    - `--jivas_version`: Specify the version of Jivas. Default is `2.0.0`.
+    - `--path`: Directory to create the agent folder in. Default is `./dafs`.
+    - `--namespace`: Namespace for the agent. Defaults to the username in the token.
+
+3. **Example**:
+    ```sh
+    jvcli create agent --name my_agent --description "My custom JIVAS AI agent"
+    ```
+
+For more information, refer to the project's documentation.
+
+## Notes
+
+- DAF packages should be thoroughly tested before deployment.
+- Follow best practices for configuration and error handling.
+
+For more information, refer to the project's documentation.

{jvcli-2.0.6 → jvcli-2.0.8}/jvcli/templates/2.0.0/project/env.example

@@ -3,7 +3,7 @@ JIVAS_PASSWORD=password
 JIVAS_PORT=8000
 JIVAS_BASE_URL=http://localhost:8000
 JIVAS_STUDIO_URL=http://localhost:8989
-JIVAS_FILES_URL=http://localhost:8000/files
+JIVAS_FILES_URL=http://localhost:9000/files
 JIVAS_DESCRIPTOR_ROOT_PATH=".jvdata"
 JIVAS_ACTIONS_ROOT_PATH="actions"
 JIVAS_DAF_ROOT_PATH="daf"

jvcli-2.0.8/jvcli/templates/2.0.0/project/sh/import_agent.sh

@@ -0,0 +1,66 @@
+#!/bin/bash
+# Script to create jivas user, login, and initialize jivas graph
+
+function initialize() {
+
+    if lsof -i :$JIVAS_PORT >/dev/null; then
+        # Try to login first
+        JIVAS_TOKEN=$(curl --silent --show-error --no-progress-meter \
+        --request POST \
+        --header 'Content-Type: application/json' \
+        --header 'Accept: application/json' \
+        --data '{"password": "'"$JIVAS_PASSWORD"'","email": "'"$JIVAS_USER"'"}' \
+        "http://localhost:$JIVAS_PORT/user/login" | grep -o '"token":"[^"]*' | sed 's/"token":"//')
+
+        echo $JIVAS_TOKEN
+
+        # Check if login was successful
+        if [ -z "$JIVAS_TOKEN" ] || [ "$JIVAS_TOKEN" == "null" ]; then
+            echo "Login failed. Registering user..."
+
+            # Register user if login failed
+            curl --silent --show-error --no-progress-meter \
+            --request POST \
+            --header 'Content-Type: application/json' \
+            --header 'Accept: application/json' \
+            --data '{
+            "password": "'"$JIVAS_PASSWORD"'",
+            "email": "'"$JIVAS_USER"'"
+            }' \
+            "http://localhost:$JIVAS_PORT/user/register"
+
+            # Attempt to login again after registration
+            JIVAS_TOKEN=$(curl --silent --show-error --no-progress-meter \
+            --request POST \
+            --header 'Content-Type: application/json' \
+            --header 'Accept: application/json' \
+            --data '{"password": "'"$JIVAS_PASSWORD"'","email": "'"$JIVAS_USER"'"}' \
+            "http://localhost:$JIVAS_PORT/user/login" | grep -oP '(?<="token":")[^"]*')
+        fi
+
+        # Print token
+        echo "Jivas token: $JIVAS_TOKEN"
+
+        echo -e "\n\nImporting demo agent...\n"
+        # Import the agent
+        AGENT_ID=$(curl --silent --show-error --no-progress-meter \
+        --request POST \
+        --header 'Content-Type: application/json' \
+        --header 'Accept: application/json' \
+        --header "Authorization: Bearer $JIVAS_TOKEN" \
+        --data '{"daf_name": "jivas/eldon_ai"}' \
+        "http://localhost:$JIVAS_PORT/walker/import_agent" | grep -o '"id":"[^"]*' | sed 's/"id":"//')
+
+        echo "$AGENT_ID\n"
+    else
+        echo "Server is not running on port $JIVAS_PORT. Waiting..."
+    fi
+
+    exit
+}
+
+# Main loop to check if a process is running on port $JIVAS_PORT
+while true; do
+    initialize
+    sleep 2  # Wait for 2 seconds before checking again
+done

jvcli-2.0.8/jvcli/templates/2.0.0/project/sh/init.sh

@@ -0,0 +1,70 @@
+#!/bin/bash
+# Script to create jivas user, login, and initialize jivas graph
+
+function initialize() {
+
+    if lsof -i :$JIVAS_PORT >/dev/null; then
+
+        # Try to login first
+        JIVAS_TOKEN=$(curl --silent --show-error --no-progress-meter \
+        --request POST \
+        --header 'Content-Type: application/json' \
+        --header 'Accept: application/json' \
+        --data '{"password": "'"$JIVAS_PASSWORD"'","email": "'"$JIVAS_USER"'"}' \
+        "http://localhost:$JIVAS_PORT/user/login" | grep -o '"token":"[^"]*' | sed 's/"token":"//')
+
+        echo $JIVAS_TOKEN
+
+        # Check if login was successful
+        if [ -z "$JIVAS_TOKEN" ] || [ "$JIVAS_TOKEN" == "null" ]; then
+            echo "Login failed. Registering user..."
+
+            # Register user if login failed
+            curl --silent --show-error --no-progress-meter \
+            --request POST \
+            --header 'Content-Type: application/json' \
+            --header 'Accept: application/json' \
+            --data '{
+            "password": "'"$JIVAS_PASSWORD"'",
+            "email": "'"$JIVAS_USER"'"
+            }' \
+            "http://localhost:$JIVAS_PORT/user/register"
+
+            # Attempt to login again after registration
+            JIVAS_TOKEN=$(curl --silent --show-error --no-progress-meter \
+            --request POST \
+            --header 'Content-Type: application/json' \
+            --header 'Accept: application/json' \
+            --data '{"password": "'"$JIVAS_PASSWORD"'","email": "'"$JIVAS_USER"'"}' \
+            "http://localhost:$JIVAS_PORT/user/login" | grep -o '"token":"[^"]*' | sed 's/"token":"//')
+        fi
+
+
+        # Print token
+        echo "Jivas token: $JIVAS_TOKEN"
+
+        echo "Initializing jivas graph..."
+
+        # Initialize agents
+        curl --silent --show-error --no-progress-meter \
+        --request POST \
+        -H 'accept: application/json' \
+        -H 'Content-Type: application/json' \
+        -H "Authorization: Bearer $JIVAS_TOKEN" \
+        --data '{}' \
+        "http://localhost:$JIVAS_PORT/walker/init_agents"
+
+        exit
+
+    else
+        echo "Server is not running on port $JIVAS_PORT. Waiting..."
+    fi
+
+    exit
+}
+
+# Main loop to check if a process is running on port $JIVAS_PORT
+while true; do
+    initialize
+    sleep 2  # Wait for 2 seconds before checking again
+done

jvcli-2.0.8/jvcli/templates/2.0.0/project/sh/serve.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+# Script to serve jivas app
+
+# Export env vars
+set -o allexport; source .env; set +o allexport
+# serve jivas app
+jac jvserve main.jac

jvcli-2.0.8/jvcli/templates/2.0.0/project/tests/README.md

@@ -0,0 +1,25 @@
+# Test Cases
+
+This directory is designated for custom test cases.
+
+## Instructions
+
+1. **Create Your Test Cases**: Place your test case scripts in this folder.
+2. **Naming Convention**: Use clear and descriptive names for your test files to ensure they are easily identifiable.
+
+## Writing Test Cases
+
+To write effective test cases, follow these guidelines:
+
+1. **Define the Purpose**: Clearly state what the test case is verifying.
+2. **Setup**: Prepare the necessary environment and inputs for the test.
+3. **Execution**: Describe the steps to execute the test.
+4. **Validation**: Specify the expected outcomes and how to validate them.
+5. **Teardown**: Clean up any resources or state after the test completes.
+
+## Notes
+
+- Test cases should be thoroughly reviewed and tested before deployment.
+- Follow best practices for scripting and error handling.
+
+For more information, refer to the project's documentation.

{jvcli-2.0.6 → jvcli-2.0.8/jvcli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: jvcli
-Version: 2.0.6
+Version: 2.0.8
 Summary: CLI tool for Jivas Package Repository
 Home-page: https://github.com/TrueSelph/jvcli
 Author: TrueSelph Inc.

{jvcli-2.0.6 → jvcli-2.0.8}/jvcli.egg-info/SOURCES.txt

@@ -47,9 +47,16 @@ jvcli/templates/2.0.0/agent_descriptor.yaml
 jvcli/templates/2.0.0/agent_info.yaml
 jvcli/templates/2.0.0/agent_knowledge.yaml
 jvcli/templates/2.0.0/agent_memory.yaml
+jvcli/templates/2.0.0/project/README.md
 jvcli/templates/2.0.0/project/env.example
 jvcli/templates/2.0.0/project/globals.jac
 jvcli/templates/2.0.0/project/main.jac
+jvcli/templates/2.0.0/project/actions/README.md
+jvcli/templates/2.0.0/project/daf/README.md
+jvcli/templates/2.0.0/project/sh/import_agent.sh
+jvcli/templates/2.0.0/project/sh/init.sh
+jvcli/templates/2.0.0/project/sh/serve.sh
+jvcli/templates/2.0.0/project/tests/README.md
 tests/test_api.py
 tests/test_auth.py
 tests/test_cli.py

{jvcli-2.0.6 → jvcli-2.0.8}/tests/test_api.py

@@ -197,7 +197,7 @@ class TestRegistryAPI:
         mock_requests.assert_called_once_with(
             RegistryAPI.url + "info",
             params={"name": "test-pkg", "version": "1.0.0"},
-            headers=None,
+            headers={},
         )
         mock_secho.assert_called_once_with(
             "Error retrieving action: Network error", fg="red"
@@ -246,7 +246,7 @@ class TestRegistryAPI:
         mock_requests.assert_called_once_with(
             RegistryAPI.url + "download",
             params={"name": "test-package", "info": "false", "version": "1.0.0"},
-            headers=None,
+            headers={},
         )
         mock_secho.assert_called_once_with(
             "Error downloading package: Network error", fg="red"
@@ -272,7 +272,7 @@ class TestRegistryAPI:
         mock_requests.assert_called_once_with(
             f"{RegistryAPI.url}info",
             params={"name": "test-action", "version": ""},
-            headers=None,
+            headers={},
         )
         assert result == {"name": "test-action", "description": "Test action"}
 
@@ -291,7 +291,7 @@ class TestRegistryAPI:
         mock_requests.assert_called_once_with(
             f"{RegistryAPI.url}info",
             params={"name": "test-action", "version": ""},
-            headers=None,
+            headers={},
         )
         mock_secho.assert_called_once_with(
             "Error retrieving action: Network error", fg="red"
@@ -316,7 +316,7 @@ class TestRegistryAPI:
         mock_requests.assert_called_once_with(
             f"{RegistryAPI.url}info",
             params={"name": "test-action", "version": ""},
-            headers=None,
+            headers={},
         )
         mock_secho.assert_called_once_with(
             "Error retrieving action: Not Found", fg="red"
@@ -742,7 +742,7 @@ class TestRegistryAPI:
         mock_get.assert_called_once_with(
             RegistryAPI.url + "download",
             params={"name": test_name, "info": "false", "version": test_version},
-            headers=None,
+            headers={},
         )
         assert result == {}
 
@@ -947,3 +947,57 @@ class TestRegistryAPI:
 
         # Assert
         assert result == {}
+
+    def test_package_download_with_api_key(self, mocker: MockerFixture) -> None:
+        """Test downloading package with API key."""
+        # Arrange
+        mock_response = mocker.Mock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {"package": "content"}
+
+        mock_get = mocker.patch("requests.get", return_value=mock_response)
+
+        test_name = "test-action"
+        test_api_key = "test-api-key"  # pragma: allowlist secret
+
+        # Act
+        result = RegistryAPI.download_package(name=test_name, api_key=test_api_key)
+
+        # Assert
+        mock_get.assert_called_once_with(
+            f"{RegistryAPI.url}download",
+            params={"name": test_name, "info": "false", "version": ""},
+            headers={"x-api-key": test_api_key},
+        )
+        assert result == {"package": "content"}
+
+    def test_package_info_with_api_key(self, mocker: MockerFixture) -> None:
+        """Test getting package info with API key."""
+        # Arrange
+        mock_response = mocker.Mock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            "name": "test-action",
+            "version": "1.0.0",
+            "description": "Test action",
+        }
+
+        mock_get = mocker.patch("requests.get", return_value=mock_response)
+
+        test_name = "test-action"
+        test_api_key = "test-api-key"  # pragma: allowlist secret
+
+        # Act
+        result = RegistryAPI.get_package_info(name=test_name, api_key=test_api_key)
+
+        # Assert
+        mock_get.assert_called_once_with(
+            f"{RegistryAPI.url}info",
+            params={"name": test_name, "version": ""},
+            headers={"x-api-key": test_api_key},
+        )
+        assert result == {
+            "name": "test-action",
+            "version": "1.0.0",
+            "description": "Test action",
+        }

{jvcli-2.0.6 → jvcli-2.0.8}/tests/test_startproject.py

@@ -34,14 +34,25 @@ class TestStartProjectCommand:
         mock_makedirs.assert_any_call("test_project", exist_ok=True)
 
         # Verify subdirectories creation
-        expected_dirs = ["tests", "actions", "daf", "scripts"]
+        expected_dirs = ["tests", "actions", "daf", "sh"]
         for dir_name in expected_dirs:
             mock_makedirs.assert_any_call(
                 os.path.join("test_project", dir_name), exist_ok=True
             )
 
         # Verify template files creation
-        expected_files = ["main.jac", "globals.jac", ".env"]
+        expected_files = [
+            "main.jac",
+            "globals.jac",
+            ".env",
+            "README.md",
+            "actions/README.md",
+            "daf/README.md",
+            "sh/init.sh",
+            "sh/import_agent.sh",
+            "sh/serve.sh",
+            "tests/README.md",
+        ]
         mock_calls = mock_open.mock_calls
         written_files = [
             call.args[0] for call in mock_calls if "test_project" in str(call)