r2flow-agent 0.3.2__tar.gz

r2flow_agent-0.3.2/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.venv/
+venv/
+*.egg
+.env
+agent_err.log
+agent_out.log

r2flow_agent-0.3.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 2kurosss
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

r2flow_agent-0.3.2/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.5
+Name: r2flow-agent
+Version: 0.3.2
+Summary: R2Flow RPA agent - runs on Windows machines and executes processes dispatched by a r2flow-cloud orchestrator
+Project-URL: Homepage, https://github.com/2kurosss/r2flow
+Project-URL: Repository, https://github.com/2kurosss/r2flow
+Project-URL: Issues, https://github.com/2kurosss/r2flow/issues
+Author: 2kurosss
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: rich>=13.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.18; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1.0; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.12; extra == 'dev'
+Provides-Extra: screenshot
+Requires-Dist: mss>=9; extra == 'screenshot'
+Requires-Dist: pillow>=10; extra == 'screenshot'
+Description-Content-Type: text/markdown
+
+# r2flow-agent
+
+Unattended worker that runs on a Windows machine, registers itself with a
+[r2flow-cloud](https://github.com/2kurosss/r2flow) orchestrator,
+polls it for commands, and executes deployed process bundles (Python code)
+in isolated per-process venvs.
+
+## One-line install (Windows)
+
+Regular PowerShell (it self-elevates and installs Python 3.12 via winget if
+missing):
+
+```powershell
+irm https://raw.githubusercontent.com/2kurosss/r2flow/main/packages/agent/install-agent.ps1 | iex
+```
+
+With parameters:
+
+```powershell
+& ([scriptblock]::Create((irm https://raw.githubusercontent.com/2kurosss/r2flow/main/packages/agent/install-agent.ps1))) `
+    -Orchestrator https://cloud.example.com -Name prod-1 -JoinToken <TOKEN>
+```
+
+## Manual install
+
+```bash
+pip install r2flow-agent
+```
+
+
+## Quick start (manual, foreground)
+
+```bash
+pip install r2flow-agent
+r2flow-agent --orchestrator http://orch-host:8000 --name my-agent \
+    --url http://this-machine:8001
+```
+
+`--url` must be the address at which the **orchestrator** can reach this
+machine (the orchestrator pushes commands and files to it).
+
+## Unattended installation (recommended)
+
+UI automation needs an **interactive desktop**, so the agent runs as a
+scheduled task inside a user's log-on session — not as a session-0 service.
+Use a dedicated local user with auto-logon for production agents.
+
+```bash
+# one command: writes config + creates the scheduled task
+r2flow-agent-service install \
+    --orchestrator http://orch-host:8000 \
+    --name prod-1 \
+    --join-token <AGENT_JOIN_TOKEN> \
+    --user "WORKGROUP\\rpa-bot"     # optional, default: current user
+
+r2flow-agent-service start        # launch now
+r2flow-agent-service status       # task state
+r2flow-agent-service stop | uninstall
+```
+
+What you get:
+
+* task trigger **at log on** of the automation user → agent starts with the
+  desktop, no manual steps after reboots;
+* Task Scheduler restart policy (up to 999 retries, 1-minute interval) and,
+  belt and braces, a crash-restart loop inside the agent with exponential
+  backoff (5 s → 60 s, reset after a stable 5-minute run);
+* config at `%LOCALAPPDATA%\r2flow_agent\config.json`, rolling log at
+  `%LOCALAPPDATA%\r2flow_agent\agent.log`.
+
+Registration honours `AGENT_JOIN_TOKEN` (pre-shared in the orchestrator
+settings) or an admin JWT — whichever you pass with `--join-token`.
+
+## Privacy note: failure screenshots
+
+On a failed run the agent (with the [screenshot] extra installed) captures
+the **entire virtual screen** — all monitors and every visible window, not
+just the automated app — and uploads it to the orchestrator. Keep this in
+mind on shared/multi-user machines: anything on screen at the moment of
+failure (other apps, browser sessions, passwords) ends up in the cloud.
+
+Deploy with the plain r2flow-agent package if screenshots are unwanted;
+the agent runs fine without the extra and simply skips capture.

r2flow_agent-0.3.2/README.md

@@ -0,0 +1,83 @@
+# r2flow-agent
+
+Unattended worker that runs on a Windows machine, registers itself with a
+[r2flow-cloud](https://github.com/2kurosss/r2flow) orchestrator,
+polls it for commands, and executes deployed process bundles (Python code)
+in isolated per-process venvs.
+
+## One-line install (Windows)
+
+Regular PowerShell (it self-elevates and installs Python 3.12 via winget if
+missing):
+
+```powershell
+irm https://raw.githubusercontent.com/2kurosss/r2flow/main/packages/agent/install-agent.ps1 | iex
+```
+
+With parameters:
+
+```powershell
+& ([scriptblock]::Create((irm https://raw.githubusercontent.com/2kurosss/r2flow/main/packages/agent/install-agent.ps1))) `
+    -Orchestrator https://cloud.example.com -Name prod-1 -JoinToken <TOKEN>
+```
+
+## Manual install
+
+```bash
+pip install r2flow-agent
+```
+
+
+## Quick start (manual, foreground)
+
+```bash
+pip install r2flow-agent
+r2flow-agent --orchestrator http://orch-host:8000 --name my-agent \
+    --url http://this-machine:8001
+```
+
+`--url` must be the address at which the **orchestrator** can reach this
+machine (the orchestrator pushes commands and files to it).
+
+## Unattended installation (recommended)
+
+UI automation needs an **interactive desktop**, so the agent runs as a
+scheduled task inside a user's log-on session — not as a session-0 service.
+Use a dedicated local user with auto-logon for production agents.
+
+```bash
+# one command: writes config + creates the scheduled task
+r2flow-agent-service install \
+    --orchestrator http://orch-host:8000 \
+    --name prod-1 \
+    --join-token <AGENT_JOIN_TOKEN> \
+    --user "WORKGROUP\\rpa-bot"     # optional, default: current user
+
+r2flow-agent-service start        # launch now
+r2flow-agent-service status       # task state
+r2flow-agent-service stop | uninstall
+```
+
+What you get:
+
+* task trigger **at log on** of the automation user → agent starts with the
+  desktop, no manual steps after reboots;
+* Task Scheduler restart policy (up to 999 retries, 1-minute interval) and,
+  belt and braces, a crash-restart loop inside the agent with exponential
+  backoff (5 s → 60 s, reset after a stable 5-minute run);
+* config at `%LOCALAPPDATA%\r2flow_agent\config.json`, rolling log at
+  `%LOCALAPPDATA%\r2flow_agent\agent.log`.
+
+Registration honours `AGENT_JOIN_TOKEN` (pre-shared in the orchestrator
+settings) or an admin JWT — whichever you pass with `--join-token`.
+
+## Privacy note: failure screenshots
+
+On a failed run the agent (with the [screenshot] extra installed) captures
+the **entire virtual screen** — all monitors and every visible window, not
+just the automated app — and uploads it to the orchestrator. Keep this in
+mind on shared/multi-user machines: anything on screen at the moment of
+failure (other apps, browser sessions, passwords) ends up in the cloud.
+
+Deploy with the plain r2flow-agent package if screenshots are unwanted;
+the agent runs fine without the extra and simply skips capture.

r2flow_agent-0.3.2/install-agent.ps1

@@ -0,0 +1,138 @@
+#requires -Version 5.1
+<#
+R2Flow agent one-line installer (Windows).
+
+Usage (regular PowerShell, elevated not required - it will self-elevate):
+
+  irm https://raw.githubusercontent.com/2kurosss/r2flow/main/packages/agent/install-agent.ps1 | iex
+
+or with parameters:
+
+  & ([scriptblock]::Create((irm https://raw.githubusercontent.com/2kurosss/r2flow/main/packages/agent/install-agent.ps1))) `
+      -Orchestrator https://cloud.example.com -Name prod-1 -JoinToken <TOKEN>
+#>
+param(
+    [string]$Orchestrator = "",
+    [string]$Name = "",
+    [string]$JoinToken = "",
+    [string]$AgentUrl = "",
+    [string]$User = "",
+    [string]$Python = "",
+    # Supply-chain pinning: point this at a release tag instead of master
+    # (e.g. https://raw.githubusercontent.com/2kurosss/r2flow/v0.2.1/install-agent.ps1)
+    [string]$RepoUrl = "https://raw.githubusercontent.com/2kurosss/r2flow/main/packages/agent/install-agent.ps1"
+)
+
+$ErrorActionPreference = "Stop"
+$VenvDir = Join-Path $env:LOCALAPPDATA "r2flow-agent\venv"
+
+function Test-Admin {
+    $id = [Security.Principal.WindowsIdentity]::GetCurrent()
+    (New-Object Security.Principal.WindowsPrincipal($id)).IsInRole(
+        [Security.Principal.WindowsBuiltInRole]::Administrator)
+}
+
+function Find-Python {
+    if ($Python -and (Test-Path $Python)) { return $Python }
+    $cmd = Get-Command python -ErrorAction SilentlyContinue
+    if ($cmd) {
+        $v = & python -c "import sys; print('%d.%d' % sys.version_info[:2])" 2>$null
+        if ($v -and [version]$v -ge [version]"3.11") { return $cmd.Source }
+    }
+    $py = Get-Command py -ErrorAction SilentlyContinue
+    if ($py) {
+        $v = & py -3 -c "import sys; print('%d.%d' % sys.version_info[:2])" 2>$null
+        if ($v -and [version]$v -ge [version]"3.11") { return "py" }
+    }
+    return ""
+}
+
+# ---------------------------------------------------------------- elevate
+if (-not (Test-Admin)) {
+    Write-Host "Not running as administrator - relaunching elevated..."
+    $tmp = Join-Path $env:TEMP "r2flow-agent-install.ps1"
+    if ($MyInvocation.MyCommand.Path -and (Test-Path $MyInvocation.MyCommand.Path)) {
+        # Elevated pass must run the exact copy the user inspected - never a
+        # fresh (possibly different) download from the network.
+        Copy-Item $MyInvocation.MyCommand.Path $tmp -Force
+    } else {
+        # irm|iex entry: no file on disk - pin to whatever RepoUrl was set to.
+        Invoke-WebRequest -UseBasicParsing -Uri $RepoUrl -OutFile $tmp
+    }
+
+    # Rebuild the invocation as an encoded command: values starting with "-"
+    # (join tokens are base64-ish) cannot be passed as bare -File arguments.
+    function Esc([string]$s) { return "'" + $s.Replace("'", "''") + "'" }
+    $inner = "& '$tmp'"
+    foreach ($p in @("Orchestrator", "Name", "JoinToken", "AgentUrl", "User", "Python")) {
+        $val = Get-Variable -Name $p -ValueOnly
+        if ($val) { $inner += " -$p $(Esc $val)" }
+    }
+    $enc = [Convert]::ToBase64String([Text.Encoding]::Unicode.GetBytes($inner))
+    $proc = Start-Process powershell -Verb RunAs -Wait -PassThru -ArgumentList @(
+        "-NoProfile", "-ExecutionPolicy", "Bypass", "-EncodedCommand", $enc)
+    exit $proc.ExitCode
+}
+
+Write-Host "=== R2Flow agent installer ==="
+
+# ---------------------------------------------------------------- orchestrator
+if (-not $Orchestrator) {
+    $Orchestrator = Read-Host "Orchestrator URL (e.g. https://cloud.example.com)"
+}
+$Orchestrator = $Orchestrator.TrimEnd("/")
+
+if (-not $Name) {
+    $hostLabel = $env:COMPUTERNAME.ToLower() -replace "[^a-z0-9-]", "-"
+    $Name = "agent-$hostLabel"
+}
+Write-Host "Orchestrator: $Orchestrator"
+Write-Host "Agent name:   $Name"
+
+# ---------------------------------------------------------------- python
+$pyExe = Find-Python
+if (-not $pyExe) {
+    Write-Host "Python 3.11+ not found - installing via winget..."
+    winget install --id Python.Python.3.12 --silent --accept-package-agreements --accept-source-agreements
+    if ($LASTEXITCODE -ne 0) { throw "winget failed to install Python; install it manually from https://python.org" }
+    # winget adds Python to the machine PATH; pick it up for this session
+    $env:PATH = [Environment]::GetEnvironmentVariable("PATH", "Machine") + ";" +
+                [Environment]::GetEnvironmentVariable("PATH", "User")
+    $pyExe = Find-Python
+    if (-not $pyExe) { throw "Python installed but not found - reopen the terminal and retry" }
+}
+Write-Host "Python:       $pyExe"
+
+# ---------------------------------------------------------------- venv
+New-Item -ItemType Directory -Force -Path (Split-Path $VenvDir) | Out-Null
+if (-not (Test-Path "$VenvDir\Scripts\python.exe")) {
+    Write-Host "Creating venv at $VenvDir ..."
+    & $pyExe -m venv $VenvDir
+    if ($LASTEXITCODE -ne 0) { throw "venv creation failed" }
+}
+Write-Host "Installing r2flow-agent[screenshot] (PyPI)..."
+& "$VenvDir\Scripts\python.exe" -m pip install --upgrade pip --quiet
+& "$VenvDir\Scripts\python.exe" -m pip install --upgrade "r2flow-agent[screenshot]" --quiet
+if ($LASTEXITCODE -ne 0) { throw "pip install r2flow-agent failed" }
+
+# ---------------------------------------------------------------- register
+$svc = "$VenvDir\Scripts\r2flow-agent-service.exe"
+if (-not (Test-Path $svc)) { $svc = "$VenvDir\Scripts\r2flow-agent-service.bat" }
+
+$installArgs = @("install", "--orchestrator", $Orchestrator, "--name", $Name)
+if ($AgentUrl)  { $installArgs += @("--url", $AgentUrl) }
+if ($JoinToken) { $installArgs += "--join-token=$JoinToken" }
+if ($User)      { $installArgs += @("--user", $User) }
+
+& $svc @installArgs
+if ($LASTEXITCODE -ne 0) { throw "r2flow-agent-service install failed (exit $LASTEXITCODE)" }
+
+Write-Host "Starting the agent..."
+& $svc start
+
+Write-Host ""
+Write-Host "=== Done ==="
+Write-Host "Agent:      $Name"
+Write-Host "Config:     $env:LOCALAPPDATA\r2flow_agent\config.json"
+Write-Host "Log:        $env:LOCALAPPDATA\r2flow_agent\agent.log"
+Write-Host "It starts automatically at logon. Check it in the orchestrator web UI."

r2flow_agent-0.3.2/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "r2flow-agent"
+version = "0.3.2"
+description = "R2Flow RPA agent - runs on Windows machines and executes processes dispatched by a r2flow-cloud orchestrator"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"
+authors = [{ name = "2kurosss" }]
+dependencies = [
+    "httpx>=0.27.0",
+    "rich>=13.0.0",
+]
+
+[project.optional-dependencies]
+screenshot = [
+    "mss>=9",
+    "Pillow>=10",
+]
+dev = [
+    "pytest>=8",
+    "pytest-asyncio>=1.0",
+    "ruff>=0.12",
+    "mypy>=1.18",
+]
+
+[project.urls]
+Homepage = "https://github.com/2kurosss/r2flow"
+Repository = "https://github.com/2kurosss/r2flow"
+Issues = "https://github.com/2kurosss/r2flow/issues"
+
+[project.scripts]
+r2flow-agent = "r2flow_agent.main:main"
+r2flow-agent-service = "r2flow_agent.service:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/r2flow_agent"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "UP", "B", "A", "C4", "SIM"]
+# B008 (function call in default) is the idiomatic argparse/click pattern.
+ignore = ["B008"]
+
+[tool.mypy]
+python_version = "3.11"
+
+[[tool.mypy.overrides]]
+module = ["mss", "mss.*", "PIL", "PIL.*"]
+ignore_missing_imports = true

r2flow_agent-0.3.2/src/r2flow_agent/__init__.py

@@ -0,0 +1,5 @@
+"""R2Flow Cloud Agent — runs on each server and communicates with the orchestrator."""
+
+from __future__ import annotations
+
+__version__ = "0.3.2"