chipping-orchestrator 0.13.0__tar.gz

chipping_orchestrator-0.13.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Geser Dugarov
+
+   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.

chipping_orchestrator-0.13.0/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.4
+Name: chipping-orchestrator
+Version: 0.13.0
+Summary: GitHub-Issue-driven AI agent workflow.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.12
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: PyGithub (>=2.10,<3)
+Requires-Dist: psycopg[binary] (>=3.3.4,<4)
+Project-URL: Documentation, https://chippingway.github.io/chipping-orchestrator/
+Project-URL: Issues, https://github.com/chippingway/chipping-orchestrator/issues
+Project-URL: Repository, https://github.com/chippingway/chipping-orchestrator
+Description-Content-Type: text/markdown
+
+# chipping-orchestrator
+
+**Autonomous GitHub issue → reviewed PR pipeline for Claude Code, Codex CLI, and Antigravity CLI.**
+
+[![CI][ci-badge]][ci-link]
+[![OpenSSF Scorecard][scorecard-badge]][scorecard-link]
+[![OpenSSF Best Practices][best-practices-badge]][best-practices-link]
+
+`chipping-orchestrator` turns GitHub issues into reviewed pull requests with local coding-agent CLIs (`codex`,
+`claude`, or `agy`). It plans the work, implements it in an isolated git worktree, reviews the result, and asks a
+human to make the final merge decision.
+
+Workflow state lives on the issue itself, so progress stays visible on GitHub and survives process restarts without a
+separate queue or workflow database.
+
+## When to use it
+
+- **Use it when:** you work solo or on a small team, have an authenticated `codex`, `claude`, or `agy` CLI, and want
+  issue-to-PR autonomy without running a separate planner, queue, or workflow database. You decide what to merge.
+- **Don't use it when:** you need a hosted service or automatic merges, cannot let agents run with the host account as
+  their security boundary, or need issue trackers other than GitHub.
+
+## How it works
+
+An issue normally follows this path:
+
+```text
+workflow:decomposing → workflow:ready → workflow:implementing
+  → workflow:validating → workflow:documenting → in_review
+  → done or rejected
+```
+
+The decomposer can split large work into child issues. The implementer commits in a dedicated worktree, the reviewer
+requests fixes until the change is ready, and the orchestrator opens or updates the pull request. The reviewer declares
+the verification its verdict relies on, which the orchestrator publishes on the pull request before acting on it; an
+approval without passing evidence covering every configured `VERIFY_COMMANDS` command waits for a human. Oversized
+changes, conflicts, retries, and human decisions take explicit side paths; pull requests are never merged automatically.
+
+See the [state-machine overview][states] for labels and transitions, and the
+[workflow guide][workflow] for agent roles and session behavior.
+
+## Requirements
+
+- Linux, Git, and Python 3.12 or newer. CI tests Python 3.12, 3.13, and 3.14; newer versions are not tested.
+- [pipx](https://pipx.pypa.io/stable/installation/) or a dedicated virtual environment for a published package;
+  [Poetry 2.5.1](https://python-poetry.org/docs/#installation) for a source checkout.
+- An authenticated CLI for every configured role. Defaults are
+  [`claude`](https://docs.anthropic.com/en/docs/claude-code) for decomposition and implementation, and
+  [`codex`](https://github.com/openai/codex) for review. Any role can instead use
+  [Antigravity (`agy`)](https://antigravity.google/docs/cli/headless/).
+- A GitHub repository and a fine-grained personal access token with read/write access to Contents, Issues, and Pull
+  requests, plus read-only access to Metadata.
+
+Agents run with their approval and sandbox checks disabled, so the host account is the security boundary. Read the
+[security checklist][security] before using the orchestrator on a public or untrusted repository.
+
+## Quick start
+
+### Install a published package
+
+Choose a version published on PyPI and replace `X.Y.Z` in the package name and constraints URL below.
+The `--backend pip` flag requires [pipx 1.12.0 or newer](https://pipx.pypa.io/stable/changelog.html).
+For older pip-only versions, omit this flag.
+
+```sh
+pipx install --python python3.12 --backend pip \
+  --pip-args="--constraint https://github.com/chippingway/chipping-orchestrator/releases/download/vX.Y.Z/constraints.txt" \
+  "chipping-orchestrator==X.Y.Z"
+```
+
+Follow the [package installation and upgrade instructions][installation] to download version-matched `.env` templates
+without cloning and configure `~/.config/chipping-orchestrator/.env`.
+The same guide covers a dedicated venv and returning to a previous version. Upgrades are operator-initiated.
+
+### Run from a source checkout
+
+Install Poetry with `pipx install poetry==2.5.1`, then clone, install from the lockfile, and copy the basic template
+into the checkout's `.env`:
+
+```sh
+git clone https://github.com/chippingway/chipping-orchestrator.git
+cd chipping-orchestrator
+env -u VIRTUAL_ENV -u CONDA_PREFIX poetry sync
+cp .env.example .env
+```
+
+Edit `.env` and set at least:
+
+- `REPOS` — the repository to manage, written `owner/name|target_root|base_branch`: its GitHub `owner/name`, the
+  absolute path to an existing local clone of it, and the branch its pull requests target. For example:
+
+  ```dotenv
+  REPOS=acme/api|/home/alice/src/acme-api|main
+  ```
+
+  The template explains the two optional trailing fields; [several repositories][multiple-repos] are
+  more entries in the same setting.
+- `HITL_HANDLE` — GitHub users to notify when human input is needed.
+- `ALLOWED_ISSUE_AUTHORS` — required: the GitHub logins whose issues and comments the orchestrator acts on; it
+  refuses to start while this names nobody.
+- `DEV_AGENT`, `REVIEW_AGENT`, and `DECOMPOSE_AGENT` — only when changing the default agent routing.
+
+Nothing from `.env.example.advanced` is needed: it holds optional operational settings and, in a section of their own,
+the developer settings for working on the orchestrator itself.
+
+Store each repository's GitHub token outside the checkout at `~/.config/<owner>/<name>/token`, or export one
+`GITHUB_TOKEN` covering every repository in the launch environment. Tokens in `.env` are deliberately ignored. Ensure
+each configured agent is logged in, then run:
+
+```sh
+./run.sh
+```
+
+On first start, the orchestrator creates its labels and begins polling open issues. Each issue gets its own worktree
+under `wt-orchestrator`, beside the first repository's clone. File a small issue to exercise the workflow; a completed
+change stops at `in_review` for a human to merge.
+
+The [configuration reference][configuration] covers both setups, credentials, agent routing, every setting,
+and advanced examples. The [operations guide][operations] covers run modes, running more
+than one poller on one host, and systemd deployment.
+
+## Asking the orchestrator a question
+
+Apply the `question` label to an open issue for a read-only answer. The configured `DECOMPOSE_AGENT` replies on the
+issue, keeps the same session for follow-up questions, and stops when the issue is closed.
+
+See the [question-stage contract][question-contract] and
+[handler behavior][question-handler].
+
+## Discussing an issue's architecture
+
+Apply the `discussion` label to work through design choices before implementation. The decomposer presents options,
+continues the conversation from your replies, and writes only `plans/issue-<number>.md` after you confirm the design.
+The orchestrator then opens a plan pull request for a human to merge, reject, or route into implementation.
+
+See the [discussion-stage contract][discussion-contract] and
+[handler behavior][discussion-handler].
+
+## Holding and unsticking an issue
+
+Use the control named by the orchestrator's park comment:
+
+| Control | Purpose |
+|---|---|
+| `backlog` | Prevent pickup until the label is removed. |
+| `paused` | Freeze an in-flight issue without discarding its state; remove the label to resume. |
+| `/orchestrator continue` | Retry a recoverable stalled run or renew a spent daily retry budget when requested. |
+| `/orchestrator authorize-oversized <commit>` | Allow the exact oversized commit named by the park to publish. |
+| `/orchestrator add-review-rounds N` | Grant more reviewer rounds after the configured cap is reached. |
+| `/orchestrator add-agent-runs N` | Raise the lifetime agent-run allowance for that issue. |
+
+Commands are accepted only in the contexts and formats described by the park comment; ordinary guidance and control
+commands are intentionally not interchangeable. See the [control-label reference][controls]
+and [delivery-stage behavior][delivery] for trust checks, limits, recovery, and exact
+effects.
+
+## Observability
+
+`orchestrator.log` records process and issue activity, while `analytics.jsonl` records transitions, timing, agent
+outcomes, usage, and cost estimates. Both live under `LOG_DIR`: `<checkout>/logs` by default in a source checkout, or
+`~/.local/state/chipping-orchestrator/logs` after [package setup][installation]. An explicit `ANALYTICS_LOG_PATH` can
+place analytics elsewhere. Optional surfaces add an audit log, a Postgres-backed analytics dashboard, and a
+file-backed trajectory viewer without becoming part of workflow state.
+
+![Analytics page with spend and token usage over time categorized by different dimensions][analytics-image]
+
+See the [observability overview][observability] for every surface and the
+[dashboard quickstart][dashboard-setup] for setup commands.
+
+## Managing multiple repositories
+
+One process manages several repositories when `REPOS` carries one entry for each. Separate the entries with `;`,
+since `.env` holds each value on a single line:
+
+```dotenv
+REPOS=acme/api|/home/alice/src/acme-api|main;acme/web|/home/alice/src/acme-web|master|upstream|2
+```
+
+Every entry names its own local clone and reads its own token file, `~/.config/<owner>/<name>/token`, unless one
+`GITHUB_TOKEN` covers them all. The optional fourth and fifth fields set the git remote that points at the repository
+(`origin` by default) and how many of its issues run at once; they are positional, so setting the limit means writing
+the remote too. Worktrees and branches are namespaced by repository, and per-repository plus global concurrency limits
+keep issues from colliding or overwhelming the host.
+
+See the [`REPOS` syntax][repos] and
+[parallel-processing settings][parallel].
+
+## Reference documentation
+
+Browse the [documentation website](https://chippingway.github.io/chipping-orchestrator/) or the
+[documentation index][documentation] for the complete reference set:
+
+| Topic | Covers |
+|---|---|
+| [Architecture][architecture] | Process model, agent model, push model, and module ownership |
+| [State machine][states] | Labels, state, stage handlers, and lifecycle |
+| [Agents][workflow] | Agent roles, conversation contracts, and command specs |
+| [Configuration][configuration] | Environment variables, defaults, and operator runbooks |
+| [Observability][observability] | Logs, analytics, dashboards, trajectories, usage, and cost |
+| [Security][security] | Deployment checklist and operator-owned controls |
+| [Release timeline][releases] | Dated milestones and functionality added in each published release |
+
+Report suspected vulnerabilities through the private process in [SECURITY.md][reporting], never through a public
+issue.
+
+## Contributing
+
+See [CONTRIBUTING.md][contributing] for writing issues, setting up a development checkout, running checks, and
+submitting pull requests.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE][license] for the full text.
+
+[ci-badge]: https://github.com/chippingway/chipping-orchestrator/actions/workflows/ci.yml/badge.svg
+[ci-link]: https://github.com/chippingway/chipping-orchestrator/actions/workflows/ci.yml
+[scorecard-badge]: https://api.scorecard.dev/projects/github.com/chippingway/chipping-orchestrator/badge
+[scorecard-link]: https://scorecard.dev/viewer/?uri=github.com/chippingway/chipping-orchestrator
+[best-practices-badge]: https://www.bestpractices.dev/projects/14235/badge
+[best-practices-link]: https://www.bestpractices.dev/projects/14235
+
+[states]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/state-machine.md
+[workflow]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/workflow.md
+[security]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/security.md
+[configuration]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/configuration.md
+[installation]:
+  https://github.com/chippingway/chipping-orchestrator/blob/main/docs/configuration.md#package-installation-upgrades-and-rollback
+[operations]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/configuration.md#run-modes
+[question-contract]:
+  https://github.com/chippingway/chipping-orchestrator/blob/main/docs/workflow/conversations.md#question-stage
+[question-handler]:
+  https://github.com/chippingway/chipping-orchestrator/blob/main/docs/state-machine/conversation-stages.md#_handle_question-label-question
+[discussion-contract]:
+  https://github.com/chippingway/chipping-orchestrator/blob/main/docs/workflow/conversations.md#discussion-stage
+[discussion-handler]:
+  https://github.com/chippingway/chipping-orchestrator/blob/main/docs/state-machine/conversation-stages.md#_handle_discussion-label-discussion
+[controls]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/configuration.md#control-labels
+[delivery]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/state-machine/delivery-stages.md
+[observability]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/observability.md
+[dashboard-setup]:
+  https://github.com/chippingway/chipping-orchestrator/blob/main/docs/configuration.md#analytics-dashboard-quickstart
+[repos]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/configuration.md#repos-syntax
+[multiple-repos]:
+  https://github.com/chippingway/chipping-orchestrator/blob/main/README.md#managing-multiple-repositories
+[parallel]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/configuration.md#parallel-processing
+[documentation]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/README.md
+[architecture]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/architecture.md
+[releases]: https://github.com/chippingway/chipping-orchestrator/blob/main/docs/release-timeline.md
+[reporting]: https://github.com/chippingway/chipping-orchestrator/blob/main/SECURITY.md
+[contributing]: https://github.com/chippingway/chipping-orchestrator/blob/main/CONTRIBUTING.md
+[license]: https://github.com/chippingway/chipping-orchestrator/blob/main/LICENSE
+[analytics-image]: https://raw.githubusercontent.com/chippingway/chipping-orchestrator/main/pics/analytics_page.png
+