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.12194.tar.gz (153.4 kB 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.12194-py3-none-any.whl (51.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for qremotex-2.0.12194.tar.gz
Algorithm Hash digest
SHA256 1987fbc1f39bc70404319e10f401f8b3921f3d0369e75a350bb4042744410d5a
MD5 befc7269ca2d17af981e0cc15729538a
BLAKE2b-256 0289a4a801a93ea156a918d6c63cb12565b45dad985ac7806cfc42dac83fa935

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qremotex-2.0.12194-py3-none-any.whl
  • Upload date:
  • Size: 51.1 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.12194-py3-none-any.whl
Algorithm Hash digest
SHA256 a53d6091d726b8783ad4f854d02b4aa0b49f45abdd1c7c9cda47b89ccaaeb721
MD5 872bafde00ddfcec1d5d66032ca9a6e9
BLAKE2b-256 e933432285f41a10962ebe6abf899ee33001bde8bcd4714f463b51a00dcc1599

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