Skip to main content

qRemoteX — Federated Remote Execution Agent for qRaptor

Project description

qRemoteX — Federated Remote Execution Agent

Lightweight agent that connects to the qRaptor Executor Gateway via WebSocket (QRP protocol) and executes Python scripts and tools on your infrastructure — on-prem, VPC, GPU clusters, or edge.

Install

Gateway URL: Your project's gateway URL is shown in the Studio UI setup wizard. Format: wss://exec-{shortId}.qraptor.app/ws/executor

Docker (Recommended)

docker run -d \
  --name qremotex \
  -e QRAPTOR_GATEWAY_URL=wss://exec-{shortId}.qraptor.app/ws/executor \
  -e QRAPTOR_API_KEY=qrx_prod_... \
  qraptor/qremotex:latest

pip (PyPI)

pip install qremotex

Kubernetes (Helm)

helm install qremotex oci://registry-1.docker.io/qraptor/qremotex \
  --set config.gatewayUrl=wss://exec-{shortId}.qraptor.app/ws/executor \
  --set secrets.apiKey=qrx_prod_...

Run

export QRAPTOR_GATEWAY_URL="wss://exec-{shortId}.qraptor.app/ws/executor"
export QRAPTOR_API_KEY="qrx_prod_..."

qremotex

Or with python -m:

python -m qremotex.main

Configuration (Environment Variables)

Variable Required Default Description
QRAPTOR_GATEWAY_URL Yes WebSocket URL (wss://...)
QRAPTOR_API_KEY Yes API key (qrx_{env}_{secret})
QRAPTOR_EXECUTOR_ID No auto (uuid4) Stable executor ID
QRAPTOR_EXECUTOR_NAME No hostname Display name
CONCURRENCY No 25 Max parallel jobs
HEARTBEAT_SEC No 20 Heartbeat interval (seconds)
EXEC_TIMEOUT_SEC No 300 Default execution timeout
MAX_SCRIPT_SIZE_KB No 512 Max script size (KB)
MAX_MEMORY_MB No 2048 Memory limit per execution
LABELS No {} JSON labels for routing ({"region":"us-east-1","gpu":"true"})
LOG_LEVEL No INFO Logging level
QRAPTOR_API_KEY_FILE No Path to key file for hot-reload (SIGHUP)
QRAPTOR_EXTRA_PACKAGES No Space-separated pip packages to install at startup (Docker only)

Installing Extra Packages

qRemoteX ships with core dependencies only. Add packages your agents need:

# Docker: inline packages
docker run -d \
  -e QRAPTOR_EXTRA_PACKAGES="pandas torch boto3" \
  -e QRAPTOR_GATEWAY_URL=wss://... \
  -e QRAPTOR_API_KEY=qrx_prod_... \
  qraptor/qremotex:latest

# Docker: custom image (recommended for production)
# Dockerfile:
#   FROM qraptor/qremotex:latest
#   USER root
#   RUN pip install --no-cache-dir pandas torch boto3
#   USER qremotex

# pip: install alongside qremotex
pip install qremotex pandas torch boto3

See qRemoteX Documentation for all installation patterns.

Deployment Options

Method Best For Registry
Docker Production, easy setup Docker Hub: qraptor/qremotex
pip Dev/testing, native Python PyPI: pip install qremotex
Helm Kubernetes clusters OCI: oci://registry-1.docker.io/qraptor/qremotex
Binary Air-gapped, no Python/Docker Download from Studio UI

Key Rotation

Rotate keys without restart:

  1. Set QRAPTOR_API_KEY_FILE=/path/to/key.txt
  2. Write the new key to the file
  3. Send kill -HUP <pid> to the agent process

Tests

pip install qremotex[dev]
pytest tests/ -v

Requirements

  • Python 3.13+ (for pip install)
  • Docker (for container deployment)
  • A qRaptor account with an active subscription

Architecture

┌─────────────┐    QRP/WebSocket     ┌──────────────────┐     API      ┌──────────────┐
│  qRemoteX   │◄──────────────────►│  qRaptor Gateway  │◄───────────►│  qRaptor     │
│  (Agent)    │   Heartbeat, Jobs   │  (Edge Router)    │             │  Studio UI   │
│             │   Results, Traces   │                   │             │              │
└──────┬──────┘                     └──────────────────┘             └──────────────┘
       │
       ▼
  Your Infrastructure
  (DB, APIs, GPU, Files)

How it works:

  1. qRemoteX connects to the qRaptor Gateway via secure WebSocket
  2. The gateway dispatches jobs (Python scripts, tool calls) to the agent
  3. The agent executes locally on your infrastructure and streams results back
  4. All communication is encrypted (TLS) and authenticated (API key + HMAC)

Learn more at qraptor.ai

License

Proprietary — Copyright © 2026 AugmentAppz. All rights reserved.

Contact: innovate@augmentappz.ai

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

qremotex-2.0.12818.tar.gz (22.0 MB view details)

Uploaded Source

Built Distribution

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

qremotex-2.0.12818-py3-none-any.whl (54.6 kB view details)

Uploaded Python 3

File details

Details for the file qremotex-2.0.12818.tar.gz.

File metadata

  • Download URL: qremotex-2.0.12818.tar.gz
  • Upload date:
  • Size: 22.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for qremotex-2.0.12818.tar.gz
Algorithm Hash digest
SHA256 74edbc8e8e74ef1bae584ceac9c859cb94e8435c6e4bd624339ba011ce71c8a5
MD5 68df1dc07b78baf6e0ac35fc73a94b98
BLAKE2b-256 4e5a3ffe82cd8b629492ac3bd27d7508c43b7f0def8a1ce87513c49f7fa0d197

See more details on using hashes here.

File details

Details for the file qremotex-2.0.12818-py3-none-any.whl.

File metadata

  • Download URL: qremotex-2.0.12818-py3-none-any.whl
  • Upload date:
  • Size: 54.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for qremotex-2.0.12818-py3-none-any.whl
Algorithm Hash digest
SHA256 6e2dc1f27f078a6b9434c6611f0bd04a2c01f3ca081f3bd54ab340382a98dc5b
MD5 65c040cae218a12bcc3cd155643d93e2
BLAKE2b-256 cfea89bcee4f1c3f5e8462225af1556633026c5acc19df153a214f6f4081947f

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