wakecycle 0.0.1__tar.gz

wakecycle-0.0.1/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Andrew Stellman
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

wakecycle-0.0.1/PKG-INFO

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: wakecycle
+Version: 0.0.1
+Summary: A batch orchestrator for AI coding agents that runs inside your existing agent session - no server, no daemon, no admin rights. (0.0.1 reserves the name; the harness ships here shortly.)
+Author-email: Andrew Stellman <andrew@stellman.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/andrewstellman/wakecycle
+Project-URL: Repository, https://github.com/andrewstellman/wakecycle
+Keywords: agent,orchestration,ai,harness,batch,claude
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Wakecycle
+
+**A batch orchestrator for AI coding agents that runs inside the agent
+session you already have — no server, no daemon, no framework, no API keys
+beyond your session, no admin rights.**
+
+Point it at a list of jobs (audit these ten repos, run this benchmark across
+these branches) and it runs them in a pool, watches their progress, and
+leaves a complete record on disk — driven entirely by your existing agent
+session waking itself on a timer, or, on a locked-down machine, by one plain
+Python script in a terminal window.
+
+## The thesis (30 seconds)
+
+Most orchestration frameworks put the intelligence in external
+infrastructure and treat the model as a worker. **The harness inverts that.**
+
+- **All the determinism lives in one small stdlib Python script** — the tick
+  engine: a disk-truth state machine advanced one idempotent tick at a time.
+- **The agent only relays and sleeps.** Each tick it runs the script, reads
+  the heartbeats of the workers it started, starts whatever the script tells
+  it to, prints a status table, and schedules the next tick. It never decides
+  anything.
+- **Disk is the database.** Every run is a directory: the plan, the live
+  status, one heartbeat file per job, one result record per job.
+- **Crash recovery is "run one tick."** Lost the session? Closed the window?
+  Machine slept? Run one command against the run directory and it picks up
+  exactly where it left off. Idempotency guarantees nothing double-runs.
+
+Because the state machine is a few hundred lines of stdlib Python and the
+agent's job is ~7 fixed steps, the orchestration runs on a small, cheap model
+— you spend your capable-model budget on the *workers*. (Verified on Haiku
+4.5; see the support table.)
+
+## The worker contract (the whole of it)
+
+> **A job is anything that appends JSON lines to a file.**
+
+A line when it starts, a line every so often, a terminal line at the end —
+single-line JSON, one writer per file. The `status` field is the only thing
+the harness interprets; everything else (`label`, `message`, an opaque `data`
+object) is decoration it displays but never reads. The worker doesn't have to
+be an AI: a shell script, a `make` target, a CI job, or a human with
+`echo >>` all qualify. A convenience helper ships for emitting the lines, but
+it's optional.
+
+The contract follows **Postel's law — conservative in what the harness
+emits, liberal in what it accepts.** A worker that never writes, dies
+mid-run, or writes garbage degrades to a visible `STALLED` / `failed` /
+`LAUNCH-FAIL` row in the status table — never to a wedged state machine. A
+malformed line is skipped with a warning, never fatal. (FR-18, FR-19)
+
+---
+
+## Quickstart — watch the whole architecture happen, zero API spend
+
+Install at user level (no admin):
+
+```bash
+pip install --user wakecycle      # Python 3.10+
+# or
+npm install wakecycle
+```
+
+> **0.0.1 is a name reservation.** Installing today gives you the `wakecycle`
+> placeholder command; the harness itself runs from this repo via
+> `python3 bin/tick.py`, `python3 bin/ticker.py`, and `python3 bin/heartbeat.py`.
+> The `wakecycle` / `wakecycle-ticker` / `wakecycle-heartbeat` console commands
+> wire up at v0.1.0; the examples below use those names.
+
+The package ships an **example plan with cross-platform Python stub
+workers** — they do no real work and spend nothing; they just walk the
+heartbeat lifecycle so you watch the architecture happen (pool-limited
+dispatch, a genuine idle tick, staggered dispatch when the first stub
+finishes, heartbeat-driven reaps, clean self-termination). (UC-8, FR-31)
+
+You can run the demo two ways. **Pick the row that matches your setup** (see
+the decision tree below for the full logic):
+
+### Path A — inside a Claude Code session (cadence rung 1)
+
+Open a fresh Claude Code session at the install and paste the bootstrap
+prompt (`references/BOOTSTRAP_PROMPT.md`), pointing it at the example plan.
+The session becomes the orchestrator and drives the run to completion on its
+own `ScheduleWakeup` timer — one paste, no further interaction until it
+reports `done` (or you drop a `STOP` file). This path uses **in-session
+subagents** as workers.
+
+### Path B — a plain terminal window (cadence rung 3, the no-admin floor)
+
+No agent session, no scheduler, no admin rights — just Python:
+
+```bash
+wakecycle-ticker path/to/demo-plan.json      # loop: tick -> spawn -> sleep -> repeat
+```
+
+The ticker replaces the agent: each tick it runs the engine, spawns the
+listed workers detached, prints the table, sleeps the cadence, repeats —
+until every job is terminal. This path uses **detached shell workers**
+(`dispatch_mode: "shell"`). The ticker runs shell entries only (a subagent
+entry is reported and skipped with the rung-1 instruction), so point it at a
+shell-dispatch plan — adapt the example by switching `dispatch_mode` to
+`"shell"` and adding a `worker_cmd`, or use the shell demo plan shipped with
+v0.1.0. (UC-5, FR-24)
+
+> The demo runs in **~20 minutes** with the shipped example plan (UC-8); its
+> pace is set by the plan's `tick_interval_minutes` and the stub's `--steps`
+> / `--sleep`, so tune those down for a faster run. Both paths produce the
+> **same** run directory — the artifacts are tier-invariant.
+
+---
+
+## Which entry point do I use? (the capability ladder)
+
+The harness degrades along two independent axes; the disk state machine is
+**identical at every rung**. At startup an orchestrating agent probes its own
+tooling and announces the rungs it selected (FR-22). As an operator, walk
+this tree:
+
+**1. Do you have an agent session with a scheduling primitive (e.g. Claude
+Code with `ScheduleWakeup`)?**
+→ **Yes:** paste the bootstrap. **Cadence rung 1 + dispatch rung 1**
+(in-session subagents). The headline workflow — zero infrastructure, one
+paste. Your session must stay open for the run's duration. *(Pair it with a
+safety tick — see below.)*
+
+**2. No agent session, but you can install a scheduler entry (cron / Task
+Scheduler / launchd / host Automations)?**
+→ Install the printed one-line schedule running `--once` at the plan cadence.
+**Cadence rung 2 + dispatch rung 2** (detached shell workers). No window
+needs to stay open; survives logout. (UC-6)
+
+**3. No scheduler rights (locked-down corporate machine)?**
+→ Run the foreground ticker in a terminal window. **Cadence rung 3 + dispatch
+rung 2** — the no-admin floor that must work everywhere. The window stays
+open for the run's duration. (UC-5)
+
+**4. Can't even keep a window open?**
+→ Advance the run by hand, one printed command at a time
+(`wakecycle-ticker --once <run-dir>`). **Cadence rung 4.** The harness never
+strands a run: every failure path prints the exact next command. (UC-7,
+FR-25)
+
+Rungs 2–4 require `dispatch_mode: "shell"` entries (an externally-ticked
+context can't launch in-session subagents — C-2).
+
+---
+
+## Host support — what's verified vs designed (honest)
+
+Per NFR-12, every claim is labeled **VERIFIED** (evidence behind it) or
+**DESIGNED** (built and unit-tested, but no end-to-end host run yet). Don't
+trust a DESIGNED cell as if it were proven.
+
+| Host / rung | Dispatch | Status | Evidence |
+|---|---|---|---|
+| Claude Code, cadence 1 (in-session timer) | subagent | **VERIFIED** | 3 Sonnet validation passes + Haiku 4.5 (one clean autonomous-loop pass + one observed failure path — the low-reasoning-model bet), 2026-06-11; multi-entry pool run with staggered dispatch, agent-honored STOP, detached workers outliving the dispatch turn (pgrep-verified) |
+| Foreground ticker, cadence 3 (no-admin floor), macOS | shell | **VERIFIED** | Live end-to-end demo in-repo, 2026-06-12: pool gating, real detached PIDs, idle tick, staggered dispatch on reap, clean DONE — independently reproduced |
+| Idempotency / idle-tick survival / STOP / resume | both | **VERIFIED** | Unit suite (mutation-verified) + spike passes; double-tick is cycle-only by construction |
+| Encoding safety (cp1252 / utf-8) | both | **VERIFIED** | AST sweep tests with mutation-verified pins |
+| OS scheduler, cadence 2 (cron / Task Scheduler / launchd) | shell | **DESIGNED** | `--once` is the cron target and unit-tested; no cross-host scheduled-run matrix yet |
+| Windows / Linux, foreground ticker | shell | **DESIGNED** | Platform branches are stdlib + unit-tested (detach flags, PID liveness, lockfile); verified live on macOS only |
+| Codex / Copilot / Cursor CLIs as workers | shell | **DESIGNED** | `worker_cmd` is CLI-agnostic by design; per-host validation is v0.2 |
+
+The in-session timer (rung 1) is reliable *as a timer* but the resumed turn
+has a host-side fragility — see the safety tick.
+
+## Deploy rung 1 with a safety tick (recommended)
+
+Because ticks are idempotent and a per-run-dir lockfile serializes concurrent
+ticks, **redundant ticking is safe by construction.** So pair a rung-1
+(in-session timer) run with a low-frequency **external safety tick** —
+cron/scheduler or a second terminal running `wakecycle-ticker --once <run-dir>`
+at roughly 3× the plan cadence against the same run directory. While the
+in-session timer is alive, safety ticks are cycle-only no-ops; if the timer's
+turn dies, the safety tick rescues the run within one safety interval, with no
+detection logic and no operator nudge. (FR-26a)
+
+**Why this matters (the honest paragraph).** In-session autonomous loops have
+a host-side failure mode we root-caused on 2026-06-12 (Claude Code 2.1.174,
+4 observed drops). The wakeup timer itself is **reliable** — it fired 4/4. The
+failure is in the resumed turn: it intermittently serializes its first tool
+call into the *text* channel as literal `<invoke …>` markup instead of a real
+tool call; when the turn ends cleanly on that, the host injects no retry and
+the loop dies silently until a human nudges it. (When the host *does* flag the
+malformed call, it injects a retry and the loop self-heals — 4/4 of those
+survived.) Context compaction was **refuted** as the cause. The safety tick
+sidesteps the whole class because an external `--once` tick is independent of
+the in-session turn. Upstream issue: **anthropics/claude-code#67945**
+(filed 2026-06-12).
+
+---
+
+## A run is a directory
+
+`--init` scaffolds a timestamped run directory; everything about the run
+lives there (FR-4):
+
+```
+<run-dir>/
+  plan.json              snapshot of the plan
+  harness_status.json    the live state machine (cycle counter, per-run state, counts)
+  queue/                 jobs not yet dispatched (+ per-job prompt files in shell mode)
+  claimed/               in-flight jobs (+ <job>.lock with PID for shell workers)
+  results/               one terminal result record per finished job
+  run-NN/                one per plan entry:
+    manifest.json          task id, target, dispatch mode, (optional) heartbeat_path
+    heartbeat.ndjson       the worker's append-only progress log
+  harness_tick.log       per-tick diagnostics
+  .tick.lock             concurrent-tick serialization (E1)
+```
+
+A completed run directory is a **self-sufficient audit record** — final
+status, every heartbeat line, every result, the plan snapshot. No chat
+scrollback required (NFR-9, FR-28).
+
+### The status table (the UI)
+
+Every tick prints a pure-ASCII table — per-run state, the worker's current
+activity label, last heartbeat status and age, plus aggregate counts and the
+next-tick time:
+
+```
+Run-Dir: 20260612T0500Z (cycle 4)
+--------------------------------------------------------------------------------------
+RUN  REPO                  MODE    STATE        ACTIVITY        LAST-HB      HB-AGE
+01   /repos/service-a      shell   completed    -               COMPLETED    1m12s
+02   /repos/service-b      shell   running      2:generation    IN_PROGRESS  0m18s
+03   /repos/service-c      shell   LAUNCH-FAIL  -               -            -
+--------------------------------------------------------------------------------------
+Queue: 0  Claimed: 0  Running: 1  Stalled: 0  Completed: 1  Failed: 1
+LAUNCH-FAIL: no heartbeat received within launch grace - check worker-side launch: auth, helper availability, paths.
+Next tick in 5 min
+```
+
+States: `queued → claimed → running → completed | failed`. `stalled` (a
+heartbeat older than the threshold) is non-terminal and recoverable. A job
+that's claimed but never heartbeats past the launch grace becomes
+`LAUNCH-FAIL` (displayed; `auth_or_launch_failed` on disk) and carries a
+diagnostic hint in both the result record and the table (FR-21b).
+
+## Stop and resume
+
+- **Stop:** drop a file named `STOP` in the run directory. The next tick sees
+  it, changes nothing, and exits cleanly — a race-free shutdown that never
+  interrupts the agent mid-action. In-flight detached workers run to their own
+  terminal states (documented orphan behavior; no kill in this release). (UC-3)
+- **Resume:** point any fresh session at the existing run directory (skip
+  `--init`), or run `wakecycle-ticker --once <run-dir>` — or just delete the
+  `STOP`. Disk state resumes the loop; at most one cycle increment beyond the
+  interruption, zero duplicated work. (UC-4)
+
+---
+
+## Lineage
+
+The harness was built as the **Quality Playbook's** test harness — replacing
+a ~10,000-line Python subprocess harness, deleted 2026-06-11 — but its core
+is payload-agnostic: the validated end-to-end runs orchestrated stub workers
+with zero Quality-Playbook involvement. It's extracted here because *a job is
+anything that appends JSON lines to a file* is a general contract, not a
+quality-tooling one. The Quality Playbook keeps a vendored copy with a
+lineage note. (See the [Quality Playbook](https://github.com/andrewstellman/quality-playbook).)
+
+## License
+
+Apache-2.0. No network calls of its own, no telemetry, no shell-out except
+the `worker_cmd` templates you declare (NFR-11).