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.20.tar.gz (290.7 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.20-py3-none-any.whl (125.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for skop_runner-0.1.20.tar.gz
Algorithm Hash digest
SHA256 8abdfd163aba707a931916cdbed0722f1483c7bcbec11c441489a24b4f77a7b0
MD5 5dc1158ed8d2307e3c13398ca6be5dc5
BLAKE2b-256 277793e0eb2d2f17bdb3c1db7409ff4775576fbc84b682915b48b1af6cc5706b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for skop_runner-0.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 8fd1db7b9cc2ff151b70a3846ad76b18e45da020534e7b2a54c090b393ffee9d
MD5 f2b791c2cab2d1b60121a2011415b76e
BLAKE2b-256 1e13bd0cc72fde54464fe13cbfcbfda9fa7ebccefd17b64c42e23d8e96c3a9f2

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