Wherobots Job Submit Extension

This Visual Studio Code extension allows you to easily submit Python scripts as job runs to the Wherobots cloud platform directly from your editor.

Installation

1. Install this extension from the VS Code marketplace
2. Configure your API key and settings (see Setup section below)
3. Start submitting Python scripts to Wherobots!

Setup

Before using the extension, you need to configure a few settings:

1. Set Your API Key

Your API key authenticates you with the Wherobots platform:

1. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
2. Type "Wherobots:Set API Key" and press Enter
3. Enter your Wherobots API key when prompted

Note: Your API key is stored securely using VS Code's built-in secret storage.

2. Configure Script Path (Optional)

The extension automatically uses your organization's default script path. You can optionally override this:

1. Open VS Code Settings (Ctrl+, / Cmd+,)
2. Search for "wherobots"
3. Set Wherobots: Script Path to your desired S3-style path (e.g., s3://my-bucket/scripts/)

If not configured, the extension will use your organization's default path from the API.

3. Configure Default Settings (Optional)

You can customize these settings in VS Code Settings (Ctrl+, / Cmd+,). Search for "wherobots" to find all available options:

Note: The extension automatically fetches your organization's default region and instance type from the Wherobots API. You only need to configure these settings if you want to override the organization defaults.

Available Instance Sizes:

• micro, tiny, small, medium, large
• x-large, 2x-large, 4x-large
• medium-himem, large-himem, x-large-himem, 2x-large-himem, 4x-large-himem
• micro-a10-gpu, tiny-a10-gpu, small-a10-gpu, medium-a10-gpu

Available Regions:

• Regions are determined by your organization settings in Wherobots
• Common regions include: aws-us-west-2, aws-eu-west-1, etc.

Usage

Configuring Jobs with Comments

You can configure job submission parameters directly in your Python files using special comments. This is especially useful when working with Jupyter notebooks that are exported as Python files.

Add configuration comments at the beginning of your Python file:

# wvsc-region: aws-us-west-2
# wvsc-instanceSize: medium
# wvsc-timeout: 7200
# wvsc-args: input.csv,output.csv

# Your Python code below
import sedona
from pyspark.sql import SparkSession

# ... rest of your code

Supported Configuration Comments:

• # wvsc-region: <region> - Cloud region (e.g., aws-us-west-2, aws-eu-west-1)
• # wvsc-instanceSize: <size> - Instance size (e.g., tiny, small, medium, large)
• # wvsc-timeout: <seconds> - Timeout in seconds (e.g., 3600 for 1 hour)
• # wvsc-args: <arg1>,<arg2>,... - Comma-separated job arguments

Priority Order: When you submit a job, configuration values are determined in this priority order:

1. Configuration comments in your Python file (highest priority)
2. VS Code settings (configured in Settings)
3. Organization defaults (from Wherobots API)
4. Hardcoded defaults (lowest priority)

This means configuration comments will override all other settings, making it easy to specify job requirements directly in your code.

First Time Setup Walkthrough

Step 1: Set Your API Key

1. Press Ctrl+Shift+P (Cmd+Shift+P on Mac) to open Command Palette
2. Type: Wherobots:Set API Key
3. Press Enter
4. Enter your API key in the secure input box
5. You'll see a confirmation: "API key saved securely!"

Step 2: Configure Script Path (Optional)

The extension automatically uses your organization's default script path.
To override it:

1. Press Ctrl+, (Cmd+, on Mac) to open Settings
2. In the search box, type: wherobots
3. Find "Wherobots: Script Path" setting
4. Enter your S3-style path (e.g., s3://my-bucket/scripts/)
5. The setting is saved automatically

Submitting a Python Script

Quick Steps:

1. Open a Python file (.py) in VS Code
2. Save the file (Ctrl+S / Cmd+S)
3. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
4. Type: Wherobots:Submit Job
5. Press Enter

What happens next:

• ✅ Configuration comments in your file are automatically detected
• ✅ The job submission form is pre-filled with values from comments
• ✅ Your script uploads to the cloud
• ✅ A job run is created in Wherobots
• ✅ You'll get a notification with a "Open Job" button
• ✅ Click "Open Job" to view your job in the web interface

Available Commands

Visual Guide

Command Palette (Ctrl+Shift+P):
┌─────────────────────────────────────────┐
│ > Wherobots:Submit Job                  │
│   Wherobots:Set API Key                 │
│                                         │
└─────────────────────────────────────────┘

Settings (search "wherobots"):
┌─────────────────────────────────────────┐
│ Wherobots: Script Path                  │
│ [s3://my-bucket/scripts/            ]   │
│                                         │
│ Wherobots: Instance Size                │
│ [tiny                              ▼]   │
└─────────────────────────────────────────┘

Supported File Types

This extension only works with Python files (.py extension). Make sure your file is saved before submitting.

Troubleshooting

Common Issues and Solutions

Detailed Troubleshooting

Problem: Job submission fails

1. Verify your API key is correct:
   • Re-run Wherobots:Set API Key with the correct key
   • Check that your key has the necessary permissions
2. Check your script path configuration:
   • Ensure the path follows S3 format: s3://bucket-name/path/
   • Verify you have write access to the specified bucket/path

Problem: Can't find Wherobots commands

1. Open Command Palette with Ctrl+Shift+P (or Cmd+Shift+P)
2. Type "Wherobots" - commands should appear
3. If not visible, try reloading VS Code window: Ctrl+Shift+P → "Developer: Reload Window"

Problem: Settings not appearing

1. Open Settings with Ctrl+, (or Cmd+,)
2. Search for "wherobots" (all lowercase)
3. If no results, the extension may not be installed or enabled

Getting Additional Help

If you continue to experience issues:

1. Check the VS Code Developer Console for error messages:
   • Help → Toggle Developer Tools → Console tab
2. Ensure you have the latest version of the extension
3. Try restarting VS Code
4. Contact Wherobots support with your error details

Release Notes

0.0.1

Initial release with basic job submission functionality.