Skip to main content

Local execution client for Skop Labs — run Jupyter notebooks from the browser on your own machine

Project description

Skop Runner

Run Jupyter notebooks from Skop on your own machine. Skop Runner connects your local computer to the Skop workspace, letting you execute code, manage files, and use your local Python environments — all from the browser.

Installation

Requires Python 3.10+.

# Recommended (isolated install, no venv needed)
uv tool install skop-runner

# Alternative
pipx install skop-runner

# Inside a virtual environment
pip install skop-runner

uv tool and pipx install skop-runner in its own isolated environment and add the CLI to your PATH. This is the recommended approach since skop-runner is a system-wide tool, not a per-project dependency.

Bare pip install into system Python is blocked on modern macOS/Linux (PEP 668). Use pip only inside an activated virtual environment.

Quick Start

1. Get your device token

Go to skoplabs.com, open a workspace, and click Add Device in the device dropdown. Copy the token.

2. Login

skop-runner login --token <your-device-token>

3. Start the runner

skop-runner start

That's it. Open your workspace in the browser and select your device — you can now browse folders, open notebooks, and execute code on your machine.

Commands

Command Description
skop-runner login --token <token> Authenticate with Skop
skop-runner start Start the runner
skop-runner status Check authentication status
skop-runner logout Remove authentication

How It Works

Skop Runner runs a local process that:

  • Connects to the Skop relay server via WebSocket
  • Manages Jupyter kernels for notebook execution
  • Serves your local files to the browser workspace
  • Detects Python environments (venv, conda, Poetry, Pipenv, pyenv)

Your code runs entirely on your machine. Skop only relays messages between your browser and the runner.

Configuration

Config is stored in ~/.skop/config.json (created by skop-runner login).

Environment variable overrides:

  • SKOP_API_URL — API URL (default: https://skoplabs.com)
  • SKOP_WS_URL — WebSocket relay URL
  • SKOP_LOG_LEVEL — Logging level (default: INFO)

Requirements

  • Python 3.10+
  • macOS or Linux (Windows support coming soon)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skop_runner-0.1.17.tar.gz (289.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

skop_runner-0.1.17-py3-none-any.whl (124.4 kB view details)

Uploaded Python 3

File details

Details for the file skop_runner-0.1.17.tar.gz.

File metadata

  • Download URL: skop_runner-0.1.17.tar.gz
  • Upload date:
  • Size: 289.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.12

File hashes

Hashes for skop_runner-0.1.17.tar.gz
Algorithm Hash digest
SHA256 aeaca1e3ea53db2462f1acf68be286e7a5da6d1be2c8f7479e3f76f5edc2d58b
MD5 fbc8c445e5bbb513b8b2090019892c50
BLAKE2b-256 299ff1d42c3ecb8fbea2e5b6a6d209c72b738be1e7e79daed148dcf4b682dd56

See more details on using hashes here.

File details

Details for the file skop_runner-0.1.17-py3-none-any.whl.

File metadata

File hashes

Hashes for skop_runner-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 61368c69c6da53fdff50710ee2ec93216d423862a82f1b50cf218c08d9f1b92f
MD5 dc256acd54b28e1ab011872bc39db59a
BLAKE2b-256 fcd01071606a14cd943e24b87daee1d25aa7086a7a8ad6bb2234764c27241ac1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page