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

{vantage_cli-0.1.2 → 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.2 → vantage_cli-0.1.4}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: vantage-cli
-Version: 0.1.2
+Version: 0.1.4
 Summary: The Vantage Compute CLI.
 Author-email: jamesbeedy <james@vantagecompute.ai>
 License: MIT
-Requires-Python: >=3.12
+Requires-Python: >=3.11
 Requires-Dist: aiohttp>=3.8.0
 Requires-Dist: anyio>=3.6.0
 Requires-Dist: gql>=4.0.0
@@ -40,7 +40,7 @@ Description-Content-Type: text/markdown
 # Vantage CLI
 
 [![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
-[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://python.org)
+[![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://python.org)
 [![PyPI](https://img.shields.io/pypi/v/vantage-cli.svg)](https://pypi.org/project/vantage-cli/)
 
 ![Build Status](https://img.shields.io/github/actions/workflow/status/vantagecompute/vantage-cli/ci.yaml?branch=main&label=build&logo=github&style=plastic)
@@ -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.2 → vantage_cli-0.1.4}/README.md

@@ -8,7 +8,7 @@
 # Vantage CLI
 
 [![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
-[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://python.org)
+[![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://python.org)
 [![PyPI](https://img.shields.io/pypi/v/vantage-cli.svg)](https://pypi.org/project/vantage-cli/)
 
 ![Build Status](https://img.shields.io/github/actions/workflow/status/vantagecompute/vantage-cli/ci.yaml?branch=main&label=build&logo=github&style=plastic)
@@ -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.2 → vantage_cli-0.1.4}/pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "vantage-cli"
-version = "0.1.2"
+version = "0.1.4"
 description = "The Vantage Compute CLI."
 authors = [
     {name = "jamesbeedy", email = "james@vantagecompute.ai"}
 ]
 readme = "README.md"
 license = {text = "MIT"}
-requires-python = ">=3.12"
+requires-python = ">=3.11"
 dependencies = [
     "juju ~= 3.6",
     "typer>=0.17.4",

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!"