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

{vantage_cli-0.1.4 → vantage_cli-0.1.6}/.github/workflows/ci.yml

@@ -46,4 +46,4 @@ jobs:
       - name: Run unit tests
         run: just unit
       - name: Run integration tests
-        run: just integration
+        run: just integration

vantage_cli-0.1.6/.github/workflows/pages.yml

@@ -0,0 +1,58 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: ["main"]
+
+  workflow_dispatch:
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-24.04
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: yarn
+          cache-dependency-path: docs/yarn.lock
+
+      - name: Install just
+        run: sudo snap install just --classic
+
+      - name: Install UV
+        run: sudo snap install astral-uv --classic
+
+      - name: Build website
+        run: just docs-build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './docs/build'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

vantage_cli-0.1.6/.gitignore

@@ -0,0 +1,66 @@
+__pycache__/
+**/__pycache__/
+**/**/__pycache__/
+
+# Docusaurus
+docs/node_modules
+docs/yarn-global
+docs/yarn-cache
+docs/.docusaurus
+docs/build
+docs/.yarn
+docs/yarn-error.log
+docs/npm-debug.log*
+docs/yarn-debug.log*
+
+
+# Python virtual environments
+.venv
+venv/
+env/
+.env
+**/.env
+
+# Coverage reports
+.coverage
+cover_unit
+cover_integration
+cover_combined
+.coverage.*
+coverage
+cover/
+htmlcov/
+
+# Testing and linting
+.tox/
+.nox/
+.pytest_cache/
+.pytest_cache/**
+.pytest_cache/**/*
+.pytest_cache/**/*
+.ruff_cache/
+.mypy_cache/
+.dmypy.json
+.dmypy.json/**
+.pyre/
+.pyre/**
+.pyre/**/*
+
+# Jupyter
+.ipynb_checkpoints
+
+# IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vantage-cli
-Version: 0.1.4
+Version: 0.1.6
 Summary: The Vantage Compute CLI.
 Author-email: jamesbeedy <james@vantagecompute.ai>
 License: MIT

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

@@ -1,6 +1,6 @@
 [project]
 name = "vantage-cli"
-version = "0.1.4"
+version = "0.1.6"
 description = "The Vantage Compute CLI."
 authors = [
     {name = "jamesbeedy", email = "james@vantagecompute.ai"}
@@ -66,6 +66,17 @@ vantage = "vantage_cli.main:app"
 
 [tool.coverage.run]
 branch = true
+omit = [
+    # Exclude new stub command modules from coverage
+    "vantage_cli/commands/job/*",
+    "vantage_cli/commands/support_ticket/*",
+    "vantage_cli/commands/team/*",
+    "vantage_cli/commands/federation/*",
+    # Exclude existing stub command modules with low coverage
+    "vantage_cli/commands/license/*",
+    "vantage_cli/commands/storage/*",
+    "vantage_cli/commands/network/*",
+]
 
 [tool.coverage.report]
 show_missing = true
@@ -123,3 +134,8 @@ max-complexity = 15
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest-cov>=7.0.0",
+]

vantage_cli-0.1.6/scripts/README.md

@@ -0,0 +1,166 @@
+# Scripts Directory
+
+This directory contains utility scripts for the Vantage CLI project.
+
+## generate_command_docs.py
+
+**Purpose**: Automatically generates comprehensive Markdown documentation from extracted CLI help files.
+
+**What it does**:
+
+- Reads command help files and index.json created by `extract_command_help.py`
+- Parses help content to extract usage, descriptions, arguments, and options
+- Generates structured Markdown documentation with collapsible sections
+- Creates properly formatted command reference documentation
+- Handles nested command structures (2+ levels deep)
+- Replaces internal python module calls with clean `vantage` command names
+
+**Output**:
+- Complete Markdown documentation file ready for documentation sites
+- Structured with headers, collapsible details, and code blocks
+- Auto-generated metadata (CLI version, generation timestamp)
+
+**Usage**:
+```bash
+# Generate to default location (docs/commands.md)
+python scripts/generate_command_docs.py
+
+# Generate from custom help directory to custom output
+python scripts/generate_command_docs.py /path/to/help/files /path/to/output.md
+
+# Complete workflow example
+python scripts/extract_command_help.py docs/command-help
+python scripts/generate_command_docs.py docs/command-help docs/commands.md
+```
+
+**Dependencies**: Requires help files generated by `extract_command_help.py`
+
+**Generated Features**:
+- Authentication commands section
+- Nested command groups with collapsible details
+- Usage examples with proper `vantage` command syntax  
+- Automatic argument and option extraction
+- Properly formatted Markdown for Jekyll/GitHub Pages
+
+## 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.
+
+## update_docs.sh
+
+**Purpose**: Complete automation script that extracts CLI help and generates comprehensive documentation in one execution.
+
+**What it does**:
+- Runs `extract_command_help.py` to discover and extract help from all commands  
+- Runs `generate_command_docs.py` to convert help files to Markdown documentation
+- Provides comprehensive logging and error handling
+- Displays summary statistics and next steps
+
+**Usage**:
+```bash
+# Complete documentation update (recommended)
+./scripts/update_docs.sh
+
+# This single command:
+# 1. Extracts help from all CLI commands → docs/command-help/
+# 2. Generates documentation → docs/commands.md  
+# 3. Provides summary and file statistics
+```
+
+**Output Summary**:
+- Help files extracted and documentation generated
+- File counts and sizes reported
+- Success/failure status for each step
+- Instructions for next steps
+
+## Complete Documentation Workflow
+
+The scripts provide a complete automation pipeline for maintaining CLI documentation:
+
+### Workflow Steps
+1. **Extract Help**: `extract_command_help.py` discovers all commands and extracts help
+2. **Generate Docs**: `generate_command_docs.py` converts help to structured Markdown
+3. **Automation**: `update_docs.sh` runs both steps with comprehensive reporting
+
+### Integration Options
+
+**Local Development**:
+```bash
+# Full automation (recommended)
+./scripts/update_docs.sh
+
+# Individual steps for debugging
+python3 scripts/extract_command_help.py docs/command-help
+python3 scripts/generate_command_docs.py docs/command-help docs/commands.md
+```
+
+**CI/CD Integration**:
+```bash
+# In build scripts or GitHub Actions
+./scripts/update_docs.sh
+
+# Or integrate individual steps with custom paths
+python3 scripts/extract_command_help.py $HELP_DIR
+python3 scripts/generate_command_docs.py $HELP_DIR $DOCS_FILE
+```
+
+**File Structure**:
+```
+docs/
+├── command-help/           # Generated by extract_command_help.py
+│   ├── main.txt           # Main CLI help
+│   ├── cloud_add.txt      # Individual command help
+│   ├── cluster_federation_create.txt
+│   ├── license_server_list.txt
+│   ├── index.json         # Command structure metadata
+│   └── ...
+└── commands.md            # Generated by generate_command_docs.py
+```
+
+## 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.