Whilly v4.0 remote-worker — meta-package that installs the minimal worker dep closure (httpx + pydantic + whilly.core + whilly.adapters.transport.client). Provides the `whilly-worker` console script via whilly-orchestrator[worker].
Project description
whilly-worker
Remote-worker meta-package for Whilly v4.0. Installs the minimal worker dep closure (
httpx+pydantic+whilly.core+whilly.adapters.transport.client) without the control-plane stack.
What this package is — and isn't
whilly-worker is a meta-package: it ships no Python source of its own. Installing it pulls in whilly-orchestrator[worker], which in turn provides the whilly-worker console script and the entire transitive code path the script needs to talk to a Whilly v4.0 control plane over HTTP.
The two install routes below are exactly equivalent — same dep tree, same console script, same versions. Pick whichever fits your tooling:
pip install whilly-worker # via this meta-package
pip install whilly-orchestrator[worker] # via the extras
The reason both exist is that operators deploying a worker VM (or building a python:3.12-slim Docker image) tend to think "I am installing the Whilly worker", not "I am installing whilly-orchestrator with the [worker] extras". The shim makes the name match the role.
Why the dep closure matters
Whilly v4.0 splits its runtime into two deployment shapes that share the pure domain layer (whilly.core) but never share a process:
| Shape | Install | Pulled deps |
|---|---|---|
| Control plane | pip install whilly-orchestrator[server] |
asyncpg + fastapi + uvicorn + alembic + sqlalchemy[asyncio] + base |
| Remote worker | pip install whilly-worker |
httpx + base (rich + pydantic + typer + a few legacy v3 runtime deps) |
| All-in-one dev | pip install whilly-orchestrator[all] |
both of the above |
The split exists for three concrete reasons (PRD §FR-1.5, §SC-6):
- A worker VM never needs Postgres clients or a web server. Pulling them in inflates the install footprint by ~50 MB and adds N+1 CVE-tracking surface for libraries the worker process literally never imports.
- Failure mode is loud, not silent. If a future refactor accidentally imports
asyncpgfrom a worker-side module, an operator on a worker-only install gets anImportErrorat process start instead of a silent compatibility shim. The.importlintercontract (TASK-029) is the static guarantee; the dep split is the runtime one. - Image hygiene. The Whilly worker Docker image (
scripts/run-v4-refactor.shdriven, see TASK-024b demo) is a singlepip install whilly-workerfrompython:3.12-slim— no need to know about extras, no need to keep a shopping list of pinned packages in the Dockerfile.
Usage example
After install, the worker is driven by the whilly-worker console script (registered by whilly-orchestrator, made available because the meta-package depends on [worker]):
# Boot a worker that connects to a Whilly control plane and drains tasks
# until SIGTERM / SIGINT (Ctrl-C). The token comes from the bootstrap-token
# flow on the control plane (POST /workers/register, TASK-022a2).
whilly-worker \
--connect https://control.whilly.example.com \
--token "$WHILLY_WORKER_TOKEN" \
--worker-id worker-vm-01
# Single-task mode — claim one task, run it, exit 0. Useful for cron-driven
# workers and for the integration tests in tests/integration/.
whilly-worker \
--connect http://localhost:8000 \
--token "$WHILLY_WORKER_TOKEN" \
--once
Equivalent environment-variable form (lets you bake an image once and inject config at runtime):
export WHILLY_CONTROL_URL=https://control.whilly.example.com
export WHILLY_WORKER_TOKEN="$(cat /run/secrets/whilly-worker-token)"
export WHILLY_WORKER_ID=worker-vm-01
whilly-worker # picks up env, runs forever
whilly-worker --once # picks up env, drains one task
Missing --token / WHILLY_WORKER_TOKEN exits with code 2 and prints a hint, instead of trying to register anonymously and failing on the first claim round-trip — that fail-fast was added in TASK-022c.
Compatibility
whilly-worker version |
Control-plane version | Python |
|---|---|---|
3.3.x (this release) |
whilly-orchestrator >= 3.3.0 (the v4.0 development line) |
3.12 / 3.13 |
4.0.0 |
whilly-orchestrator == 4.0.0 (TASK-033a release) |
3.12 / 3.13 |
The dependency on whilly-orchestrator[worker] is pinned to the exact same version (==3.3.0), not loosely constrained. The wire protocol between RemoteWorkerClient and the FastAPI endpoints is part of the same release train, so worker and control plane must move together.
Where the actual code lives
whilly.cli.worker—whilly-workerconsole-script entry point (TASK-022c)whilly.worker.remote— async loop (claim → run → complete | fail) over HTTP (TASK-022b1/2/3)whilly.adapters.transport.client— theRemoteWorkerClient(TASK-022a1/2/3)whilly.core— pure domain layer, zero external deps
All of these ship inside the whilly-orchestrator wheel. This meta-package only gates which dependencies pip resolves around them.
See also
docs/Whilly-v4-Architecture.md— Hexagonal layout: core / adapters / server / worker / clidocs/Whilly-v4-Worker-Protocol.md— HTTP API spec the worker speaksdocs/demo-remote-worker.sh— end-to-end SC-3 reproduction
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file whilly_worker-4.4.1.tar.gz.
File metadata
- Download URL: whilly_worker-4.4.1.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
07fb2e0406995dc56ec04f50d3df72fe6175808142b3448e6ff685512a3684ca
|
|
| MD5 |
ad55f63fc16766019a1d139980040d1b
|
|
| BLAKE2b-256 |
ec742099451b90c1708802b955d04abe84163d051a60e227b8ede684d87ec4c8
|
File details
Details for the file whilly_worker-4.4.1-py3-none-any.whl.
File metadata
- Download URL: whilly_worker-4.4.1-py3-none-any.whl
- Upload date:
- Size: 3.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7876001170ca47ca5f3470b45843c506ec30aa14f0cb0daa805da95964a898f3
|
|
| MD5 |
2c052ddf493dfb5f4cfefae03adf0619
|
|
| BLAKE2b-256 |
e2c9046235c7b7a287682b2360572503492059b44cb3b3575e774032869855e4
|