vantage-cli 0.1.3__tar.gz → 0.1.4__tar.gz

{vantage_cli-0.1.3 → vantage_cli-0.1.4}/.github/workflows/pages.yml

@@ -28,6 +28,28 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Update documentation version
+        run: |
+          # Extract version from pyproject.toml and update docs
+          VERSION=$(grep '^version = ' pyproject.toml | sed 's/version = "\(.*\)"/\1/')
+          TODAY=$(date +%Y-%m-%d)
+          echo "📝 Updating docs with version: $VERSION"
+          
+          # Update all documentation files
+          sed -i "s/^version: .*/version: \"$VERSION\"/" docs/_data/project.yml
+          sed -i "s/^updated: .*/updated: \"$TODAY\"/" docs/_data/project.yml
+          
+          if grep -q "^version:" docs/_config.yml; then
+              sed -i "s/^version: .*/version: \"$VERSION\"/" docs/_config.yml
+          else
+              sed -i "/^description:/a version: \"$VERSION\"" docs/_config.yml
+          fi
+          
+          if grep -q "^version:" docs/index.md; then
+              sed -i "s/^version: .*/version: \"$VERSION\"/" docs/index.md
+          else
+              sed -i "/^permalink:/a version: \"$VERSION\"" docs/index.md
+          fi
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Build with Jekyll

{vantage_cli-0.1.3 → vantage_cli-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vantage-cli
-Version: 0.1.3
+Version: 0.1.4
 Summary: The Vantage Compute CLI.
 Author-email: jamesbeedy <james@vantagecompute.ai>
 License: MIT
@@ -78,6 +78,34 @@ cd vantage-cli && uv sync
 uv run vantage login
 ```
 
+## Deploy a Slurm Cluster
+
+### Localhost
+
+#### Create a Singlenode Slurm Cluster using Multipass
+
+```bash
+vantage clusters create my-slurm-multipass-cluster \
+    --cloud localhost \
+    --deploy slurm-multipass-localhost
+```
+
+#### Create a Slurm Cluster on LXD
+
+```bash
+vantage clusters create my-slurm-lxd-cluster \
+    --cloud localhost \
+    --deploy slurm-juju-localhost
+```
+
+#### Create a Slurm Cluster on MicroK8S
+
+```bash
+vantage clusters create my-slurm-microk8s-cluster \
+    --cloud localhost \
+    --deploy slurm-microk8s-locahost
+```
+
 ## 📚 Documentation
 
 Visit our comprehensive documentation site:

{vantage_cli-0.1.3 → vantage_cli-0.1.4}/README.md

@@ -46,6 +46,34 @@ cd vantage-cli && uv sync
 uv run vantage login
 ```
 
+## Deploy a Slurm Cluster
+
+### Localhost
+
+#### Create a Singlenode Slurm Cluster using Multipass
+
+```bash
+vantage clusters create my-slurm-multipass-cluster \
+    --cloud localhost \
+    --deploy slurm-multipass-localhost
+```
+
+#### Create a Slurm Cluster on LXD
+
+```bash
+vantage clusters create my-slurm-lxd-cluster \
+    --cloud localhost \
+    --deploy slurm-juju-localhost
+```
+
+#### Create a Slurm Cluster on MicroK8S
+
+```bash
+vantage clusters create my-slurm-microk8s-cluster \
+    --cloud localhost \
+    --deploy slurm-microk8s-locahost
+```
+
 ## 📚 Documentation
 
 Visit our comprehensive documentation site:

{vantage_cli-0.1.3 → vantage_cli-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "vantage-cli"
-version = "0.1.3"
+version = "0.1.4"
 description = "The Vantage Compute CLI."
 authors = [
     {name = "jamesbeedy", email = "james@vantagecompute.ai"}

vantage_cli-0.1.4/scripts/README.md

@@ -0,0 +1,55 @@
+# Scripts Directory
+
+This directory contains utility scripts for the Vantage CLI project.
+
+## update_docs_version.py
+
+**Purpose**: Automatically updates documentation files with the current version from `pyproject.toml`.
+
+**Files Updated**:
+- `docs/_data/project.yml` - Updates version and date fields
+- `docs/_config.yml` - Adds/updates version field
+- `docs/index.md` - Adds version to front matter
+
+**Usage**:
+```bash
+# Using justfile (recommended)
+just update-docs-version
+
+# Direct execution
+python scripts/update_docs_version.py
+
+# Using shell wrapper
+./scripts/update_docs_version.sh
+```
+
+**Dependencies**: 
+- Python 3.7+ with `tomllib` (Python 3.11+) or `tomli` package
+
+## update_docs_version.sh
+
+**Purpose**: Shell wrapper for `update_docs_version.py` that handles dependency installation.
+
+**Usage**:
+```bash
+./scripts/update_docs_version.sh
+```
+
+## Integration
+
+### Local Development
+Use `just update-docs-version` before building documentation locally.
+
+### CI/CD (GitHub Pages)
+The version update is automatically integrated into the GitHub Pages workflow in `.github/workflows/pages.yml`.
+
+### Manual Execution
+Both Python script and shell wrapper can be run independently for custom build processes.
+
+## When to Use
+
+- **Before releasing**: Ensure documentation reflects the current version
+- **Before building docs**: Keep documentation in sync with package version
+- **In CI/CD**: Automatically update version during deployment
+
+The scripts are designed to be idempotent - running them multiple times with the same version will not cause issues.

vantage_cli-0.1.4/scripts/update_docs_version.py

@@ -0,0 +1,150 @@
+#!/usr/bin/env python3
+"""
+Update documentation files with version from pyproject.toml
+
+This script reads the version from pyproject.toml and updates:
+1. docs/_data/project.yml (replaces __VERSION__ placeholder)
+2. docs/_config.yml (adds version field)
+3. Any other documentation files that need version updates
+"""
+
+import re
+import sys
+from datetime import datetime
+from pathlib import Path
+from typing import Any, Dict
+
+try:
+    import tomllib
+except ImportError:
+    # Python < 3.11 fallback
+    try:
+        import tomli as tomllib
+    except ImportError:
+        print("Error: tomllib (Python 3.11+) or tomli package required")
+        sys.exit(1)
+
+
+def load_pyproject_version() -> str:
+    """Load version from pyproject.toml"""
+    pyproject_path = Path(__file__).parent.parent / "pyproject.toml"
+    
+    if not pyproject_path.exists():
+        raise FileNotFoundError(f"pyproject.toml not found at {pyproject_path}")
+    
+    with open(pyproject_path, "rb") as f:
+        data = tomllib.load(f)
+    
+    version = data.get("project", {}).get("version")
+    if not version:
+        raise ValueError("Version not found in pyproject.toml")
+    
+    return version
+
+
+def update_project_yml(version: str) -> None:
+    """Update docs/_data/project.yml with the current version"""
+    project_yml_path = Path(__file__).parent.parent / "docs" / "_data" / "project.yml"
+    
+    if not project_yml_path.exists():
+        print(f"Warning: {project_yml_path} not found, skipping")
+        return
+    
+    content = project_yml_path.read_text(encoding="utf-8")
+    
+    # Replace version placeholder
+    updated_content = re.sub(
+        r'version:\s*["\']?__VERSION__["\']?',
+        f'version: "{version}"',
+        content
+    )
+    
+    # Update the date as well
+    today = datetime.now().strftime("%Y-%m-%d")
+    updated_content = re.sub(
+        r'updated:\s*["\']?[\d-]+["\']?',
+        f'updated: "{today}"',
+        updated_content
+    )
+    
+    project_yml_path.write_text(updated_content, encoding="utf-8")
+    print(f"✓ Updated {project_yml_path} with version {version}")
+
+
+def update_config_yml(version: str) -> None:
+    """Update docs/_config.yml with the current version"""
+    config_yml_path = Path(__file__).parent.parent / "docs" / "_config.yml"
+    
+    if not config_yml_path.exists():
+        print(f"Warning: {config_yml_path} not found, skipping")
+        return
+    
+    content = config_yml_path.read_text(encoding="utf-8")
+    
+    # Check if version field already exists
+    if re.search(r'^version:\s*', content, re.MULTILINE):
+        # Update existing version
+        updated_content = re.sub(
+            r'^version:\s*.*$',
+            f'version: "{version}"',
+            content,
+            flags=re.MULTILINE
+        )
+    else:
+        # Add version field after description
+        updated_content = re.sub(
+            r'(description:.*?\n)',
+            f'\\1version: "{version}"\n',
+            content,
+            flags=re.DOTALL
+        )
+    
+    config_yml_path.write_text(updated_content, encoding="utf-8")
+    print(f"✓ Updated {config_yml_path} with version {version}")
+
+
+def update_index_md(version: str) -> None:
+    """Update docs/index.md with version information if needed"""
+    index_md_path = Path(__file__).parent.parent / "docs" / "index.md"
+    
+    if not index_md_path.exists():
+        print(f"Warning: {index_md_path} not found, skipping")
+        return
+    
+    content = index_md_path.read_text(encoding="utf-8")
+    
+    # Add version to the front matter if it doesn't exist
+    if "version:" not in content and "---" in content:
+        # Insert version into front matter
+        updated_content = re.sub(
+            r'(---\n.*?)\n(---)',
+            f'\\1\nversion: "{version}"\n\\2',
+            content,
+            flags=re.DOTALL
+        )
+        
+        if updated_content != content:
+            index_md_path.write_text(updated_content, encoding="utf-8")
+            print(f"✓ Updated {index_md_path} with version {version}")
+
+
+def main() -> None:
+    """Main function to update all documentation files with version"""
+    try:
+        version = load_pyproject_version()
+        print(f"📝 Updating documentation with version: {version}")
+        
+        # Update all documentation files
+        update_project_yml(version)
+        update_config_yml(version)
+        update_index_md(version)
+        
+        print(f"🎉 Successfully updated documentation files with version {version}")
+        
+    except Exception as e:
+        print(f"❌ Error updating documentation version: {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

vantage_cli-0.1.4/scripts/update_docs_version.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+# Update documentation version from pyproject.toml
+# This script can be run locally or in CI/CD
+
+set -e
+
+# Get the directory where this script is located
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(dirname "$SCRIPT_DIR")"
+
+echo "🔄 Updating documentation version..."
+
+# Check if we're in a Python environment with the required packages
+if command -v python3 >/dev/null 2>&1; then
+    PYTHON_CMD="python3"
+elif command -v python >/dev/null 2>&1; then
+    PYTHON_CMD="python"
+else
+    echo "❌ Error: Python not found"
+    exit 1
+fi
+
+# Try to run the update script
+cd "$PROJECT_ROOT"
+
+# Check if tomli/tomllib is available
+if ! $PYTHON_CMD -c "import sys; import tomllib if sys.version_info >= (3, 11) else __import__('tomli')" 2>/dev/null; then
+    echo "📦 Installing tomli for Python < 3.11..."
+    # Try different installation methods
+    if command -v pip >/dev/null 2>&1; then
+        pip install --quiet tomli
+    elif command -v pip3 >/dev/null 2>&1; then
+        pip3 install --quiet tomli
+    elif $PYTHON_CMD -m pip --version >/dev/null 2>&1; then
+        $PYTHON_CMD -m pip install --quiet tomli
+    else
+        echo "⚠️  Warning: Could not install tomli. Script may fail for Python < 3.11"
+    fi
+fi
+
+# Run the update script
+$PYTHON_CMD scripts/update_docs_version.py
+
+echo "✅ Documentation version update complete!"

{vantage_cli-0.1.3 → vantage_cli-0.1.4}/uv.lock

@@ -1710,7 +1710,7 @@ wheels = [
 
 [[package]]
 name = "vantage-cli"
-version = "0.1.3"
+version = "0.1.4"
 source = { editable = "." }
 dependencies = [
     { name = "aiohttp" },

vantage_cli-0.1.4/vantage_cli/apps/__init__.py

@@ -0,0 +1,19 @@
+# © 2025 Vantage Compute, Inc. All rights reserved.
+# Confidential and proprietary. Unauthorized use prohibited.
+"""Applications management commands for Vantage CLI."""
+
+from vantage_cli import AsyncTyper
+from vantage_cli.commands.apps.deploy import deploy_app
+from vantage_cli.commands.apps.list import list_apps
+
+# Create the apps command group
+apps_app = AsyncTyper(
+    name="apps",
+    help="Deploy and manage applications on Vantage compute clusters.",
+    invoke_without_command=True,
+    no_args_is_help=True,
+)
+
+# Register commands
+apps_app.command("list")(list_apps)
+apps_app.command("deploy")(deploy_app)

vantage_cli-0.1.4/vantage_cli/apps/slurm_juju_localhost/__init__.py

@@ -0,0 +1,5 @@
+"""Juju localhost deployment app package."""
+
+from .app import deploy
+
+__all__ = ["deploy"]

vantage_cli-0.1.4/vantage_cli/apps/slurm_multipass_localhost/__init__.py

@@ -0,0 +1,5 @@
+"""Multipass single-node deployment app package."""
+
+from .app import deploy
+
+__all__ = ["deploy"]

vantage_cli-0.1.4/vantage_cli/commands/apps/__init__.py

@@ -0,0 +1,22 @@
+# © 2025 Vantage Compute, Inc. All rights reserved.
+# Confidential and proprietary. Unauthorized use prohibited.
+"""Application deployment commands for Vantage CLI."""
+
+from vantage_cli import AsyncTyper
+
+from .deploy import deploy_app
+from .list import list_apps
+
+# Create the apps command group
+apps_app = AsyncTyper(
+    name="apps",
+    help="Deploy and manage applications on Vantage compute clusters.",
+    invoke_without_command=True,
+    no_args_is_help=True,
+)
+
+# Register subcommands directly
+apps_app.command("list")(list_apps)
+apps_app.command("deploy")(deploy_app)
+
+__all__ = ["apps_app"]

vantage_cli-0.1.4/vantage_cli/commands/apps/deploy.py

@@ -0,0 +1,72 @@
+# © 2025 Vantage Compute, Inc. All rights reserved.
+# Confidential and proprietary. Unauthorized use prohibited.
+"""Deploy and register clusters."""
+
+from typing import Annotated
+
+import typer
+from rich.console import Console
+
+from vantage_cli.commands.clusters.utils import get_available_apps, get_cluster_by_name
+from vantage_cli.config import attach_settings
+
+console = Console()
+
+
+@attach_settings
+async def deploy_app(
+    ctx: typer.Context,
+    app_name: Annotated[
+        str, typer.Argument(help="Name of the cluster infrastructure application to deploy")
+    ],
+    cluster_name: Annotated[
+        str, typer.Argument(help="Name of the cluster in Vantage you would like to link to")
+    ],
+) -> None:
+    """Deploy a slurm cluster and link it to a cluster entity in Vantage."""
+    try:
+        # Get available apps
+        available_apps = get_available_apps()
+
+        if app_name not in available_apps:
+            console.print(f"[bold red]✗ App '{app_name}' not found[/bold red]")
+            console.print(f"\nAvailable apps: {', '.join(available_apps.keys())}")
+            console.print("Use [cyan]vantage apps list[/cyan] to see all available applications.")
+            raise typer.Exit(1)
+
+        console.print(
+            f"[bold blue]Deploying app '{app_name}' to cluster '{cluster_name}'...[/bold blue]"
+        )
+
+        # Get cluster data
+        cluster_data = await get_cluster_by_name(ctx, cluster_name)
+        if not cluster_data:
+            console.print(f"[bold red]✗ Cluster '{cluster_name}' not found[/bold red]")
+            raise typer.Exit(1)
+
+        # Get the app info
+        app_info = available_apps[app_name]
+
+        # Check if this is a function-based app
+        if "deploy_function" in app_info:
+            # Function-based app
+            deploy_function = app_info["deploy_function"]
+
+            # Call the deploy function with cluster data
+            await deploy_function(ctx, cluster_data)
+
+            console.print(
+                f"[bold green]✓ App '{app_name}' deployed successfully to cluster '{cluster_name}'![/bold green]"
+            )
+        else:
+            console.print(
+                f"[bold red]✗ App '{app_name}' does not have a deploy function[/bold red]"
+            )
+            raise typer.Exit(1)
+
+    except typer.Exit:
+        # Re-raise typer.Exit to maintain exit codes
+        raise
+    except Exception as e:
+        console.print(f"[bold red]✗ Error deploying app '{app_name}': {e}[/bold red]")
+        raise typer.Exit(1)

vantage_cli-0.1.4/vantage_cli/commands/apps/list.py

@@ -0,0 +1,97 @@
+# © 2025 Vantage Compute, Inc. All rights reserved.
+# Confidential and proprietary. Unauthorized use prohibited.
+"""List available applications for deployment."""
+
+from typing import Annotated
+
+import typer
+from rich.console import Console
+from rich.table import Table
+
+from vantage_cli.commands.clusters.utils import get_available_apps
+from vantage_cli.config import attach_settings
+from vantage_cli.format import render_json
+
+console = Console()
+
+
+@attach_settings
+async def list_apps(
+    ctx: typer.Context,
+    json_output: Annotated[
+        bool, typer.Option("--json", "-j", help="Output in JSON format")
+    ] = False,
+) -> None:
+    """List all available applications for deployment."""
+    try:
+        # Get available apps
+        available_apps = get_available_apps()
+
+        if json_output:
+            # Format for JSON output
+            apps_data = []
+            for app_name, app_info in available_apps.items():
+                app_data = {
+                    "name": app_name,
+                    "module": app_info["module"].__name__
+                    if "module" in app_info and hasattr(app_info["module"], "__name__")
+                    else "unknown",
+                }
+
+                # Try to get description from docstring if available
+                if "deploy_function" in app_info:
+                    func = app_info["deploy_function"]
+                    if hasattr(func, "__doc__") and func.__doc__:
+                        app_data["description"] = func.__doc__.strip().split("\n")[0]
+                    else:
+                        app_data["description"] = "No description available"
+                else:
+                    app_data["description"] = "No deploy function available"
+
+                apps_data.append(app_data)
+
+            render_json({"apps": apps_data})
+            return
+
+        # Rich table output
+        if not available_apps:
+            console.print("[yellow]No applications found.[/yellow]")
+            return
+
+        table = Table(
+            title="Available Applications", show_header=True, header_style="bold magenta"
+        )
+        table.add_column("App Name", style="cyan", width=20)
+        table.add_column("Module", style="green", width=30)
+        table.add_column("Description", style="white", width=50)
+
+        for app_name, app_info in available_apps.items():
+            # Get module name
+            module_name = "unknown"
+            if "module" in app_info:
+                module_name = (
+                    app_info["module"].__name__
+                    if hasattr(app_info["module"], "__name__")
+                    else "unknown"
+                )
+
+            # Get description from docstring
+            description = "No description available"
+            if "deploy_function" in app_info:
+                func = app_info["deploy_function"]
+                if hasattr(func, "__doc__") and func.__doc__:
+                    # Get first line of docstring
+                    description = func.__doc__.strip().split("\n")[0]
+                else:
+                    description = "No description available"
+            else:
+                description = "No deploy function available"
+
+            table.add_row(app_name, module_name, description)
+
+        console.print(table)
+        console.print(f"\n[bold]Found {len(available_apps)} application(s)[/bold]")
+
+    except Exception as e:
+        console.print(f"[bold red]Error listing applications: {e}[/bold red]")
+        raise typer.Exit(1)

vantage_cli-0.1.3/vantage_cli/apps/__init__.py

@@ -1,19 +0,0 @@
-# © 2025 Vantage Compute, Inc. All rights reserved.
-# Confidential and proprietary. Unauthorized use prohibited.
-"""Cluster management commands for Vantage CLI."""
-
-from vantage_cli import AsyncTyper
-from vantage_cli.apps.juju_localhost import juju_localhost_app
-from vantage_cli.apps.multipass_singlenode import multipass_singlenode_app
-
-# Create the apps command group
-apps_app = AsyncTyper(
-    name="apps",
-    help="Vantage infrastructure automation applications.",
-    invoke_without_command=True,
-    no_args_is_help=True,
-)
-
-# Register subcommand groups
-apps_app.add_typer(juju_localhost_app)
-apps_app.add_typer(multipass_singlenode_app)

vantage_cli-0.1.3/vantage_cli/apps/juju_localhost/__init__.py

@@ -1,14 +0,0 @@
-"""Juju localhost deployment app package."""
-
-from vantage_cli import AsyncTyper
-
-from .app import deploy_command
-
-juju_localhost_app = AsyncTyper(
-    name="juju-localhost",
-    help="Juju localhost SLURM application commands.",
-    invoke_without_command=True,
-    no_args_is_help=True,
-)
-
-juju_localhost_app.command("deploy")(deploy_command)

vantage_cli-0.1.3/vantage_cli/apps/multipass_singlenode/__init__.py

@@ -1,14 +0,0 @@
-"""Multipass single-node deployment app package."""
-
-from vantage_cli import AsyncTyper
-
-from .app import deploy_command
-
-multipass_singlenode_app = AsyncTyper(
-    name="multipass-singlenode",
-    help="Multipass single-node application commands.",
-    invoke_without_command=True,
-    no_args_is_help=True,
-)
-
-multipass_singlenode_app.command("deploy")(deploy_command)