sunholo 0.87.0__tar.gz → 0.88.2__tar.gz

{sunholo-0.87.0 → sunholo-0.88.2}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: sunholo
-Version: 0.87.0
+Version: 0.88.2
 Summary: Large Language Model DevOps - a package to help deploy LLMs to the Cloud.
 Home-page: https://github.com/sunholo-data/sunholo-py
-Download-URL: https://github.com/sunholo-data/sunholo-py/archive/refs/tags/v0.87.0.tar.gz
+Download-URL: https://github.com/sunholo-data/sunholo-py/archive/refs/tags/v0.88.2.tar.gz
 Author: Holosun ApS
 Author-email: multivac@sunholo.com
 License: Apache License, Version 2.0
@@ -64,6 +64,7 @@ Requires-Dist: playwright; extra == "all"
 Requires-Dist: psutil; extra == "all"
 Requires-Dist: psycopg2-binary; extra == "all"
 Requires-Dist: pypdf; extra == "all"
+Requires-Dist: python-hcl2; extra == "all"
 Requires-Dist: python-socketio; extra == "all"
 Requires-Dist: pytesseract; extra == "all"
 Requires-Dist: rich; extra == "all"
@@ -135,6 +136,8 @@ Provides-Extra: excel
 Requires-Dist: xlwings; extra == "excel"
 Requires-Dist: requests; extra == "excel"
 Requires-Dist: rich; extra == "excel"
+Provides-Extra: iac
+Requires-Dist: python-hcl2; extra == "iac"
 
 ## Introduction
 This is the Sunholo Python project, a comprehensive toolkit for working with language models and vector stores on Google Cloud Platform. It provides a wide range of functionalities and utilities to facilitate the development and deployment of language model applications.

{sunholo-0.87.0 → sunholo-0.88.2}/setup.py

@@ -1,7 +1,6 @@
 from setuptools import setup, find_packages
 
-# Define your base version
-version = '0.87.0'
+version = '0.88.2'
 
 setup(
     name='sunholo',
@@ -29,7 +28,6 @@ setup(
     install_requires=[
         # Base dependencies
         "google-auth", # to check if on gcp
-        #"tenacity==8.3.0", #TODO: remove soon
         "ruamel.yaml",
         "langchain>=0.2.12",
         "langchain_experimental>=0.0.61",
@@ -78,6 +76,7 @@ setup(
             "psutil",
             "psycopg2-binary",
             "pypdf",
+            "python-hcl2",
             "python-socketio",
             "pytesseract",
             "rich",
@@ -160,6 +159,9 @@ setup(
             'xlwings',
             'requests',
             'rich'
+        ],
+        'iac':[
+            'python-hcl2'
         ]
 
     },

{sunholo-0.87.0 → sunholo-0.88.2}/sunholo/__init__.py

@@ -19,6 +19,7 @@ from . import patches
 from . import pubsub
 from . import qna
 from . import streaming
+from . import terraform
 from . import tools
 from . import utils
 from . import vertex
@@ -46,6 +47,7 @@ __all__ = ['agents',
            'pubsub',
            'qna', 
            'streaming', 
+           'terraform',
            'tools',
            'utils', 
            'vertex',

{sunholo-0.87.0 → sunholo-0.88.2}/sunholo/cli/cli.py

@@ -12,6 +12,7 @@ from .swagger import setup_swagger_subparser
 from .vertex import setup_vertex_subparser
 from ..llamaindex import setup_llamaindex_subparser
 from ..excel import setup_excel_subparser
+from ..terraform import setup_tfvarseditor_subparser
 
 from ..utils import ConfigManager
 from ..utils.version import sunholo_version
@@ -65,13 +66,13 @@ def main(args=None):
     parser.add_argument('--debug', action='store_true', help='Enable debug output')
     parser.add_argument('--project', default=default_project, help='GCP project to list Cloud Run services from.')
     parser.add_argument('--region', default=default_region, help='Region to list Cloud Run services from.')
-    parser.add_argument('--version', action='store_true', help='Show the version and exit') 
+    parser.add_argument('-v', '--version', action='store_true', help='Show the version and exit')
 
     subparsers = parser.add_subparsers(title='commands', 
                                        description='Valid commands', 
                                        help='Commands', 
                                        dest='command', 
-                                       required=True)
+                                       required=False)
 
     # deploy command
     setup_deploy_subparser(subparsers)
@@ -95,11 +96,18 @@ def main(args=None):
     setup_llamaindex_subparser(subparsers)
     # excel
     setup_excel_subparser(subparsers)
+    # terraform
+    setup_tfvarseditor_subparser(subparsers)
 
     #TODO: add database setup commands: alloydb and supabase
 
     args = parser.parse_args(args)
 
+    # Handle global flags
+    if args.version:
+        console.print(sunholo_version())
+        return
+
     if args.debug:
         log.setLevel(logging.DEBUG)
         logging.getLogger().setLevel(logging.DEBUG)
@@ -107,14 +115,9 @@ def main(args=None):
         log.setLevel(logging.WARNING)
         logging.getLogger().setLevel(logging.WARNING)
 
-    if args.version:
-        sunholo_version()
-        return
-
+    # Handle subcommand
     if hasattr(args, 'func'):
         args.func(args)
     else:
         parser.print_help()
 
-if __name__ == "__main__":
-    main()

sunholo-0.88.2/sunholo/cli/cli_init.py

@@ -0,0 +1,116 @@
+import os
+import shutil
+from ..utils.config import get_module_filepath
+
+def init_project(args):
+    """
+    Initializes a new sunholo project with a basic configuration file and directory structure.
+
+**Template Files (`templates/project`):**
+
+A `templates/project` directory is within the `sunholo` package with the following template files in it:
+
+* **`config/llm_config.yaml`:** A basic configuration file with placeholders for LLM settings, vector stores, etc.
+* **`config/cloud_run_urls.json`:** A template for Cloud Run URLs.
+* **`app.py`:** A basic Flask app that can be customized for the project.
+* **`.gitignore`:** A gitignore file to exclude unnecessary files from version control.
+* **`README.md`:** A README file with instructions for setting up and running the project.
+
+**Usage:**
+
+Users can initialize a new project using the following command:
+
+```bash
+sunholo init my_genai_project
+```
+
+This will create a new directory named `my_genai_project` with the template files, allowing users to start building their GenAI application.
+    """
+    project_name = args.project_name
+    current_dir = os.getcwd()  # This captures the current directory where the command is run
+    project_dir = os.path.join(current_dir, project_name)
+
+    print(f"Initializing project: {project_name} in directory: {project_dir}")
+
+    # Create project directory
+    if os.path.exists(project_dir):
+        print(f"Directory {project_dir} already exists. Please choose a different project name.")
+        return
+
+    os.makedirs(project_dir)
+
+    # Copy template files
+    template_dir = get_module_filepath("templates/project")
+    for filename in os.listdir(template_dir):
+        src_path = os.path.join(template_dir, filename)
+        dest_path = os.path.join(project_dir, filename)
+        if os.path.isfile(src_path):
+            shutil.copy(src_path, dest_path)
+        elif os.path.isdir(src_path):
+            shutil.copytree(src_path, dest_path)
+
+    # Determine the location of the generated.tfvars file
+    terraform_dir = args.terraform_dir or os.getenv('MULTIVAC_TERRAFORM_DIR')
+    if terraform_dir is None:
+        raise ValueError("Must specify a terraform_dir or use the MULTIVAC_TERRAFORM_DIR environment variable")
+    
+    tfvars_file = os.path.join(terraform_dir, 'generated.tfvars')
+
+    # Get the service account, either from the CLI argument or default
+    service_account = args.service_account or "sa-llmops"  # Default service account
+
+    # Determine the relative path for the cloud build included directories
+    def get_relative_application_path(full_path: str, base_dir: str) -> str:
+        application_base_index = full_path.find("application/")
+        if application_base_index != -1:
+            return full_path[application_base_index:]
+        return os.path.relpath(full_path, base_dir)
+
+    # Paths to be included in the cloud build (based on the current working directory)
+    # We want paths to start from 'application/system_services/{project_name}'
+    relative_base = os.path.relpath(current_dir, os.path.join(current_dir, "..", ".."))
+    included_path = os.path.join(relative_base, project_name, "**")
+    cloud_build_path = os.path.join(relative_base, project_name, "cloudbuild.yaml")
+
+    # Define the cloud_run configuration for 'discord-server' with the correct project_dir path
+    cloud_run_config = {
+        project_name: {
+            "cpu": "1",
+            "memory": "2Gi",
+            "max_instance_count": 3,
+            "timeout_seconds": 1500,
+            "port": 8080,
+            "service_account": service_account,
+            "invokers": ["allUsers"],
+            "cloud_build": {
+                "included": [included_path],
+                "path": cloud_build_path,
+                "substitutions": {},
+                "repo_name": "",
+                "repo_owner": ""
+            }
+        }
+    }
+
+
+    # Initialize the TerraformVarsEditor and update the .tfvars file
+    try:
+        from ..terraform import TerraformVarsEditor
+        editor = TerraformVarsEditor(tfvars_file, terraform_dir)
+        editor.update_from_dict(cloud_run_config, 'cloud_run')
+        print(f"{tfvars_file} file initialized and updated successfully.")
+    except ImportError as e:
+        print(f"Error initializing TerraformVarsEditor: {e}")
+
+    print(f"Project {project_name} initialized successfully.")
+    print(f"Navigate to {project_dir} and customize the configuration files in the 'config' directory.")
+
+def setup_init_subparser(subparsers):
+    """
+    Sets up an argparse subparser for the 'init' command.
+    """
+    init_parser = subparsers.add_parser('init', help='Initializes a new Multivac project.')
+    init_parser.add_argument('project_name', help='The name of the new project.')
+    init_parser.add_argument('--terraform-dir', help='The directory where Terraform files will be generated.')
+    init_parser.add_argument('--service-account', help='The service account to use for Cloud Run. Defaults to "sa-llmops"')
+    init_parser.set_defaults(func=init_project)

sunholo-0.88.2/sunholo/terraform/__init__.py

@@ -0,0 +1 @@
+from .tfvars_editor import setup_tfvarseditor_subparser, TerraformVarsEditor

sunholo-0.88.2/sunholo/terraform/tfvars_editor.py

@@ -0,0 +1,339 @@
+try:
+    import hcl2
+except ImportError:
+    hcl2 = None
+
+import json
+import subprocess
+import os
+import io
+from typing import Dict, Any
+from ..custom_logging import log
+
+try:
+    from ..cli.sun_rich import console
+except ImportError:
+    console = None
+
+class TerraformVarsEditor:
+    """
+    A class to manage and safely edit Terraform .tfvars files.
+
+    This class allows you to update specific keys in a .tfvars file with new data
+    and ensures that the changes only take effect if Terraform validation passes.
+
+    Attributes:
+    ----------
+    tfvars_file : str
+        The path to the .tfvars file to be edited.
+    terraform_dir : str
+        The directory where Terraform commands will be executed (default is current directory).
+    tfvars_data : dict
+        The content of the .tfvars file loaded into a dictionary.
+    
+    Methods:
+    -------
+    _load_tfvars() -> Dict[str, Any]
+        Loads the .tfvars file into a dictionary.
+    _save_tfvars() -> None
+        Saves the current state of the dictionary back to the .tfvars file.
+    _backup_tfvars() -> str
+        Creates a backup of the current .tfvars file.
+    _restore_tfvars(backup_file: str) -> None
+        Restores the .tfvars file from the backup.
+    update_or_add_instance(main_key: str, instance_name: str, instance_data: Dict[str, Any]) -> None
+        Adds or updates an instance under a specified top-level key in the .tfvars file.
+    validate_terraform() -> bool
+        Runs `terraform validate` in the specified directory.
+    update_from_json(json_file: str, main_key: str) -> None
+        Updates the .tfvars file based on the content of a JSON file and validates the changes.
+    """
+
+    def __init__(self, tfvars_file: str, terraform_dir: str = '.') -> None:
+        """
+        Initializes the TerraformVarsEditor with the given .tfvars file and Terraform directory.
+
+        Parameters:
+        ----------
+        tfvars_file : str
+            The path to the .tfvars file to be edited.
+        terraform_dir : str
+            The directory where Terraform commands will be executed (default is current directory). Will use MULTIVAC_TERRAFORM_DIR env var if present.
+
+        Example:
+        -------
+        editor = TerraformVarsEditor('example.tfvars', '/path/to/terraform/config')
+        """
+        if hcl2 is None:
+            raise ImportError('hcl2 is required for parsing terraform files, install via `pip install sunholo[iac]`')
+
+        # Check for the MULTIVAC_TERRAFORM_DIR environment variable
+        if terraform_dir == '.' and 'MULTIVAC_TERRAFORM_DIR' in os.environ:
+            terraform_dir = os.environ['MULTIVAC_TERRAFORM_DIR']
+        
+        log.info(f'MULTIVAC_TERRAFORM_DIR environment variable is set to {terraform_dir}')
+        
+        self.tfvars_file = tfvars_file
+        self.terraform_dir = terraform_dir
+        self.tfvars_data = self._load_tfvars()
+
+    def _load_tfvars(self) -> Dict[str, Any]:
+        """
+        Loads the .tfvars file into a dictionary.
+
+        Returns:
+        -------
+        dict
+            The content of the .tfvars file.
+
+        Example:
+        -------
+        data = self._load_tfvars()
+        """
+        with open(self.tfvars_file, 'r') as file:
+            return hcl2.load(file)
+
+    def _save_tfvars(self) -> None:
+        """
+        Saves the current state of the dictionary back to the .tfvars file.
+
+        Example:
+        -------
+        self._save_tfvars()
+        """
+        with open(self.tfvars_file, 'w') as file:
+            for key, value in self.tfvars_data.items():
+                file.write(f'{key} = {json.dumps(value, indent=2)}\n')
+
+    def _backup_tfvars(self) -> str:
+        """
+        Creates a backup of the current .tfvars file.
+
+        Returns:
+        -------
+        str
+            The path to the backup file.
+
+        Example:
+        -------
+        backup_file = self._backup_tfvars()
+        """
+        backup_file = f"{self.tfvars_file}.bak"
+        os.rename(self.tfvars_file, backup_file)
+        return backup_file
+
+    def _restore_tfvars(self, backup_file: str) -> None:
+        """
+        Restores the .tfvars file from the backup.
+
+        Parameters:
+        ----------
+        backup_file : str
+            The path to the backup file to restore from.
+
+        Example:
+        -------
+        self._restore_tfvars('example.tfvars.bak')
+        """
+        os.rename(backup_file, self.tfvars_file)
+
+    def update_or_add_instance(self, main_key: str, instance_name: str, instance_data: Dict[str, Any]) -> None:
+        """
+        Adds or updates an instance under a specified top-level key in the .tfvars file.
+
+        Parameters:
+        ----------
+        main_key : str
+            The top-level key in the .tfvars file (e.g., "cloud_run").
+        instance_name : str
+            The name of the instance to add or update.
+        instance_data : dict
+            The dictionary containing the instance data.
+
+        Example:
+        
+        ```python
+        editor.update_or_add_instance('cloud_run', 'new_service', (your dict))
+        ```
+        """
+        if main_key not in self.tfvars_data:
+            self.tfvars_data[main_key] = {}
+
+        self.tfvars_data[main_key][instance_name] = instance_data
+
+    def validate_terraform(self) -> bool:
+        """
+        Runs `terraform init` followed by `terraform validate` in the specified directory.
+
+        Returns:
+        -------
+        bool
+            True if validation passes, False otherwise.
+
+        Example:
+        -------
+        ```python
+        if self.validate_terraform():
+            print("Validation passed.")
+        ```
+        """
+        # Step 1: Run `terraform init` to ensure the directory is initialized
+        init_process = subprocess.run(['terraform', 'init'], cwd=self.terraform_dir, capture_output=True, text=True)
+        
+        if init_process.returncode != 0:
+            log.error("Terraform initialization failed.")
+            print(init_process.stdout)
+            print(init_process.stderr)
+            return False
+        
+        log.info("Terraform initialized successfully.")
+
+        # Step 2: Run `terraform validate`
+        validate_process = subprocess.run(['terraform', 'validate'], cwd=self.terraform_dir, capture_output=True, text=True)
+        
+        if validate_process.returncode == 0:
+            log.info("Terraform validation passed.")
+            return True
+        else:
+            log.error("Terraform validation failed.")
+            print(validate_process.stdout)
+            print(validate_process.stderr)
+            return False
+
+    def update_from_json(self, json_file: str, main_key: str) -> None:
+        """
+        Updates the .tfvars file based on the content of a JSON file and validates the changes.
+
+        Parameters:
+        ----------
+        json_file : str
+            The path to the JSON file with the new instance data.
+        main_key : str
+            The top-level key in the .tfvars file (e.g., "cloud_run").
+
+        Example:
+        -------
+        editor.update_from_json('update.json', 'cloud_run')
+        """
+        with open(json_file, 'r') as file:
+            data = json.load(file)
+
+        # Update the tfvars data in memory
+        for instance_name, instance_data in data.get(main_key, {}).items():
+            self.update_or_add_instance(main_key, instance_name, instance_data)
+
+        # Backup the original .tfvars file
+        backup_file = self._backup_tfvars()
+
+        # Temporarily save the updated data to the original file location
+        self._save_tfvars()
+
+        # Attempt to validate the changes with Terraform
+        if not self.validate_terraform():
+            # If validation fails, restore the original file from the backup
+            self._restore_tfvars(backup_file)
+            log.error(f"Changes aborted, original {self.tfvars_file} restored.")
+        else:
+            log.info(f"Terraform validation passed, changes saved to {self.tfvars_file}.")
+            os.remove(backup_file)  # Remove the backup if validation passes
+
+    def update_from_dict(self, data: Dict[str, Any], main_key: str) -> None:
+        """
+        Updates the .tfvars file based on the content of a Python dictionary and validates the changes.
+
+        Parameters:
+        ----------
+        data : dict
+            The dictionary with the new instance data.
+        main_key : str
+            The top-level key under which the instance is added (e.g., "cloud_run").
+
+        Example:
+        -------
+        editor.update_from_dict(data, 'cloud_run')
+        """
+        # Create an in-memory file-like object from the dictionary by converting it to JSON
+        json_data = json.dumps({main_key: data})
+        json_file = io.StringIO(json_data)
+
+        # Load the JSON data from the StringIO object
+        parsed_data = json.load(json_file)
+
+        # Update the tfvars data in memory
+        for instance_name, instance_data in parsed_data.get(main_key, {}).items():
+            self.update_or_add_instance(main_key, instance_name, instance_data)
+
+        # Now that the data is updated in memory, proceed to validate and write it back to the file
+        # Backup the original .tfvars file
+        backup_file = self._backup_tfvars()
+
+        # Temporarily save the updated data to the original file location
+        self._save_tfvars()
+
+        # Attempt to validate the changes with Terraform
+        if not self.validate_terraform():
+            # If validation fails, restore the original file from the backup
+            self._restore_tfvars(backup_file)
+            console.print(f"Changes aborted, original {self.tfvars_file} restored.")
+        else:
+            console.print(f"Terraform validation passed, changes saved to {self.tfvars_file}.")
+            os.remove(backup_file)  # Remove the backup if validation passes
+
+def tfvars_command(args):
+    """
+    Executes the tfvars command based on parsed arguments.
+
+    Args:
+        args: The parsed command-line arguments.
+    """
+
+    if console is None:
+        raise ImportError("Need cli tools to use `sunholo tfvars` - install via `pip install sunholo[cli]`")
+    
+    # Load JSON data from the specified file
+    try:
+        with open(args.json_file, 'r') as f:
+            instance_data = json.load(f)
+    except FileNotFoundError:
+        console.print(f"Error: The JSON file '{args.json_file}' was not found.")
+        return
+    except json.JSONDecodeError as e:
+        console.print(f"Error parsing JSON data: {e}")
+        return
+
+    # Create an instance of TerraformVarsEditor
+    editor = TerraformVarsEditor(args.tfvars_file, args.terraform_dir)
+
+    # Add or update the instance
+    editor.update_or_add_instance(args.main_key, args.instance_name, instance_data)
+
+    # Validate the Terraform configuration
+    if editor.validate_terraform():
+        console.print(f"Successfully updated '{args.instance_name}' under '{args.main_key}' in '{args.tfvars_file}'.")
+    else:
+        console.print(f"[bold red]Failed to update '{args.instance_name}'. The changes have been rolled back.[/bold red]")
+
+def setup_tfvarseditor_subparser(subparsers):
+    """
+    Sets up an argparse subparser for the 'tfvars' command.
+
+    Args:
+        subparsers: The subparsers object from argparse.ArgumentParser().
+    """
+    # TFVars subparser setup
+    tfvars_parser = subparsers.add_parser('tfvars', help='Manage Terraform .tfvars files')
+    tfvars_subparsers = tfvars_parser.add_subparsers(dest='action', help='TFVars subcommands')
+
+    # TFVars add command
+    add_parser = tfvars_subparsers.add_parser('add', help='Add or update an instance in a .tfvars file')
+    add_parser.add_argument('tfvars_file', help='Path to the .tfvars file')
+    add_parser.add_argument('main_key', help='The main key under which the instance is added (e.g., "cloud_run")')
+    add_parser.add_argument('instance_name', help='The name of the instance to add or update')
+    add_parser.add_argument('--json-file', help='Path to a JSON file with the instance data', required=True)
+    add_parser.add_argument('--terraform-dir', default='.', help='The directory where Terraform is initialized')
+
+    tfvars_parser.set_defaults(func=tfvars_command)
+
+    # If no subcommand is provided, print the help message
+    tfvars_parser.set_defaults(func=lambda args: tfvars_parser.print_help() if args.action is None else tfvars_command)
+

{sunholo-0.87.0 → sunholo-0.88.2}/sunholo.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: sunholo
-Version: 0.87.0
+Version: 0.88.2
 Summary: Large Language Model DevOps - a package to help deploy LLMs to the Cloud.
 Home-page: https://github.com/sunholo-data/sunholo-py
-Download-URL: https://github.com/sunholo-data/sunholo-py/archive/refs/tags/v0.87.0.tar.gz
+Download-URL: https://github.com/sunholo-data/sunholo-py/archive/refs/tags/v0.88.2.tar.gz
 Author: Holosun ApS
 Author-email: multivac@sunholo.com
 License: Apache License, Version 2.0
@@ -64,6 +64,7 @@ Requires-Dist: playwright; extra == "all"
 Requires-Dist: psutil; extra == "all"
 Requires-Dist: psycopg2-binary; extra == "all"
 Requires-Dist: pypdf; extra == "all"
+Requires-Dist: python-hcl2; extra == "all"
 Requires-Dist: python-socketio; extra == "all"
 Requires-Dist: pytesseract; extra == "all"
 Requires-Dist: rich; extra == "all"
@@ -135,6 +136,8 @@ Provides-Extra: excel
 Requires-Dist: xlwings; extra == "excel"
 Requires-Dist: requests; extra == "excel"
 Requires-Dist: rich; extra == "excel"
+Provides-Extra: iac
+Requires-Dist: python-hcl2; extra == "iac"
 
 ## Introduction
 This is the Sunholo Python project, a comprehensive toolkit for working with language models and vector stores on Google Cloud Platform. It provides a wide range of functionalities and utilities to facilitate the development and deployment of language model applications.

{sunholo-0.87.0 → sunholo-0.88.2}/sunholo.egg-info/SOURCES.txt

@@ -130,6 +130,8 @@ sunholo/streaming/stream_lookup.py
 sunholo/streaming/streaming.py
 sunholo/summarise/__init__.py
 sunholo/summarise/summarise.py
+sunholo/terraform/__init__.py
+sunholo/terraform/tfvars_editor.py
 sunholo/tools/__init__.py
 sunholo/tools/web_browser.py
 sunholo/utils/__init__.py

{sunholo-0.87.0 → sunholo-0.88.2}/sunholo.egg-info/requires.txt

@@ -45,6 +45,7 @@ playwright
 psutil
 psycopg2-binary
 pypdf
+python-hcl2
 python-socketio
 pytesseract
 rich
@@ -110,6 +111,9 @@ langfuse
 python-socketio
 requests
 
+[iac]
+python-hcl2
+
 [openai]
 langchain-openai
 tiktoken