ralphkit 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
ralphkit/__init__.py ADDED
@@ -0,0 +1 @@
1
+ __version__ = "0.1.0"
ralphkit/cli.py ADDED
@@ -0,0 +1,190 @@
1
+ import argparse
2
+ import sys
3
+ from dataclasses import replace
4
+ from pathlib import Path
5
+
6
+ from ralphkit.config import VERDICT_REVISE, VERDICT_SHIP, RalphConfig, load_config
7
+ from ralphkit.prompts import (
8
+ REVIEWER_SYSTEM_PROMPT,
9
+ WORKER_SYSTEM_PROMPT,
10
+ reviewer_user_prompt,
11
+ worker_user_prompt,
12
+ )
13
+ from ralphkit.runner import run_claude
14
+ from ralphkit.state import StateDir
15
+
16
+ # ── Colors ──────────────────────────────────────────────────────────
17
+ RED = "\033[0;31m"
18
+ GREEN = "\033[0;32m"
19
+ YELLOW = "\033[1;33m"
20
+ BLUE = "\033[0;34m"
21
+ NC = "\033[0m"
22
+
23
+
24
+ def resolve_task(raw: str) -> str:
25
+ """If the string ends with .md and the file exists, read it. Otherwise return as-is."""
26
+ if raw.endswith(".md"):
27
+ p = Path(raw)
28
+ try:
29
+ return p.read_text()
30
+ except (FileNotFoundError, OSError):
31
+ pass
32
+ return raw
33
+
34
+
35
+ def merge_config(config: RalphConfig, args: argparse.Namespace) -> RalphConfig:
36
+ """Overlay explicit CLI args on top of config values."""
37
+ overrides = {}
38
+ if args.worker_model is not None:
39
+ overrides["worker_model"] = args.worker_model
40
+ if args.reviewer_model is not None:
41
+ overrides["reviewer_model"] = args.reviewer_model
42
+ if args.max_iterations is not None:
43
+ overrides["max_iterations"] = args.max_iterations
44
+ return replace(config, **overrides) if overrides else config
45
+
46
+
47
+ def main() -> None:
48
+ parser = argparse.ArgumentParser(
49
+ description="Iterative work/review loop for Claude Code",
50
+ )
51
+ parser.add_argument(
52
+ "task",
53
+ help="Task description (string or path to .md file)",
54
+ )
55
+ parser.add_argument(
56
+ "--config",
57
+ default=None,
58
+ help="Path to YAML config file (only loaded when explicitly provided)",
59
+ )
60
+ parser.add_argument(
61
+ "--worker-model",
62
+ default=None,
63
+ help="Model for work phase (default: opus)",
64
+ )
65
+ parser.add_argument(
66
+ "--reviewer-model",
67
+ default=None,
68
+ help="Model for review phase (default: sonnet)",
69
+ )
70
+ parser.add_argument(
71
+ "--max-iterations",
72
+ type=int,
73
+ default=None,
74
+ help="Max work/review cycles (default: 10)",
75
+ )
76
+ parser.add_argument(
77
+ "-y",
78
+ "--yes",
79
+ action="store_true",
80
+ help="Skip confirmation prompt",
81
+ )
82
+ args = parser.parse_args()
83
+
84
+ config = load_config(args.config)
85
+ config = merge_config(config, args)
86
+ task_content = resolve_task(args.task)
87
+
88
+ state = StateDir()
89
+ state.setup()
90
+ state.clean()
91
+ state.write_task(task_content)
92
+
93
+ # ── Banner ──────────────────────────────────────────────────────
94
+ first_line = task_content.split("\n", 1)[0]
95
+ print()
96
+ print(f"{BLUE}{'=' * 59}{NC}")
97
+ print(f"{BLUE} RALPH LOOP{NC}")
98
+ print(f"{BLUE}{'=' * 59}{NC}")
99
+ print()
100
+ print(f" {YELLOW}Task:{NC} {first_line}")
101
+ print(f" {YELLOW}Worker:{NC} {config.worker_model}")
102
+ print(f" {YELLOW}Reviewer:{NC} {config.reviewer_model}")
103
+ print(f" {YELLOW}Max iter:{NC} {config.max_iterations}")
104
+ print()
105
+
106
+ # ── Confirmation ────────────────────────────────────────────────
107
+ if not args.yes:
108
+ print(
109
+ f"{YELLOW}Warning: This will run up to {config.max_iterations} iterations using two AI models.{NC}"
110
+ )
111
+ print(f"{YELLOW} Each iteration costs API credits.{NC}")
112
+ print()
113
+ confirm = input("Proceed? (y/N) ").strip()
114
+ if confirm.lower() not in ("y", "yes"):
115
+ print(f"{RED}Aborted.{NC}")
116
+ sys.exit(1)
117
+ print()
118
+
119
+ # ── Main loop ───────────────────────────────────────────────────
120
+ for i in range(1, config.max_iterations + 1):
121
+ print(f"{BLUE}{'-' * 59}{NC}")
122
+ print(f"{BLUE} Iteration {i} / {config.max_iterations}{NC}")
123
+ print(f"{BLUE}{'-' * 59}{NC}")
124
+ print()
125
+
126
+ state.write_iteration(i)
127
+
128
+ # ── Work phase ──────────────────────────────────────────────
129
+ print(f" {YELLOW}Work phase ({config.worker_model})...{NC}")
130
+ run_claude(worker_user_prompt(i), config.worker_model, WORKER_SYSTEM_PROMPT)
131
+ print(f" {GREEN} Done.{NC}")
132
+
133
+ # Check for blocked state
134
+ blocked = state.is_blocked()
135
+ if blocked:
136
+ print()
137
+ print(f"{RED}Worker is BLOCKED:{NC}")
138
+ print(blocked)
139
+ sys.exit(1)
140
+
141
+ # Show work summary
142
+ summary = state.read_work_summary()
143
+ if summary:
144
+ print()
145
+ print(f" {YELLOW} Summary:{NC}")
146
+ for line in summary.splitlines():
147
+ print(f" {line}")
148
+ print()
149
+
150
+ # ── Review phase ────────────────────────────────────────────
151
+ print(f" {YELLOW}Review phase ({config.reviewer_model})...{NC}")
152
+ run_claude(
153
+ reviewer_user_prompt(), config.reviewer_model, REVIEWER_SYSTEM_PROMPT
154
+ )
155
+ print(f" {GREEN} Done.{NC}")
156
+ print()
157
+
158
+ # ── Check review result ─────────────────────────────────────
159
+ result = state.read_review_result()
160
+ if result is None:
161
+ print(f"{RED}Review failed: no review-result.txt produced.{NC}")
162
+ sys.exit(1)
163
+
164
+ if result == VERDICT_SHIP:
165
+ print(f"{GREEN}{'=' * 59}{NC}")
166
+ print(f"{GREEN} SHIP — Task completed in {i} iteration(s)!{NC}")
167
+ print(f"{GREEN}{'=' * 59}{NC}")
168
+ print()
169
+ sys.exit(0)
170
+ elif result == VERDICT_REVISE:
171
+ print(f" {YELLOW}REVISE — Reviewer wants changes.{NC}")
172
+ feedback = state.read_review_feedback()
173
+ if feedback:
174
+ print()
175
+ print(f" {YELLOW} Feedback:{NC}")
176
+ for line in feedback.splitlines():
177
+ print(f" {line}")
178
+ print()
179
+ state.clean_for_next_iteration()
180
+ else:
181
+ print(f"{RED}Unexpected review result: '{result}'{NC}")
182
+ sys.exit(1)
183
+
184
+ # ── Max iterations reached ──────────────────────────────────────
185
+ print()
186
+ print(f"{RED}{'=' * 59}{NC}")
187
+ print(f"{RED} Max iterations ({config.max_iterations}) reached without SHIP.{NC}")
188
+ print(f"{RED}{'=' * 59}{NC}")
189
+ print()
190
+ sys.exit(1)
ralphkit/config.py ADDED
@@ -0,0 +1,30 @@
1
+ from dataclasses import dataclass, fields
2
+ from pathlib import Path
3
+
4
+ import yaml
5
+
6
+ STATE_DIR = ".ralphkit"
7
+
8
+ VERDICT_SHIP = "SHIP"
9
+ VERDICT_REVISE = "REVISE"
10
+
11
+
12
+ @dataclass
13
+ class RalphConfig:
14
+ worker_model: str = "opus"
15
+ reviewer_model: str = "sonnet"
16
+ max_iterations: int = 10
17
+
18
+
19
+ def load_config(path: str | Path | None) -> RalphConfig:
20
+ """Load config from a YAML file. Returns defaults when path is None."""
21
+ if path is None:
22
+ return RalphConfig()
23
+ path = Path(path)
24
+ with open(path) as f:
25
+ data = yaml.safe_load(f) or {}
26
+ valid_fields = {f.name for f in fields(RalphConfig)}
27
+ kwargs = {k: data[k] for k in data if k in valid_fields}
28
+ if "max_iterations" in kwargs:
29
+ kwargs["max_iterations"] = int(kwargs["max_iterations"])
30
+ return RalphConfig(**kwargs)
ralphkit/prompts.py ADDED
@@ -0,0 +1,60 @@
1
+ from ralphkit.config import STATE_DIR, VERDICT_REVISE, VERDICT_SHIP
2
+
3
+ WORKER_SYSTEM_PROMPT = f"""\
4
+ You are in a RALPH LOOP - an iterative work/review cycle.
5
+ Your work persists through FILES ONLY. You will NOT remember previous iterations.
6
+
7
+ STATE FILES (in {STATE_DIR}/):
8
+ - task.md = The task you need to accomplish (READ THIS FIRST)
9
+ - iteration.txt = Current iteration number
10
+ - review-feedback.txt = Feedback from last review (if exists)
11
+ - work-complete.txt = Create this when task is DONE
12
+
13
+ WORKFLOW:
14
+ 1. Read {STATE_DIR}/task.md to understand your task
15
+ 2. Read {STATE_DIR}/iteration.txt to know which iteration this is
16
+ 3. Read {STATE_DIR}/review-feedback.txt if it exists — address feedback FIRST
17
+ 4. Look at existing files (ls) to see prior work
18
+ 5. Do the work — make meaningful progress
19
+ 6. Run tests/verification if applicable
20
+ 7. Write what you did to {STATE_DIR}/work-summary.txt
21
+ 8. If task is complete, write "done" to {STATE_DIR}/work-complete.txt"""
22
+
23
+ REVIEWER_SYSTEM_PROMPT = f"""\
24
+ You are a CODE REVIEWER in a RALPH LOOP.
25
+ You are a DIFFERENT MODEL than the worker. Use your fresh perspective.
26
+
27
+ Review the work and decide: {VERDICT_SHIP} or {VERDICT_REVISE}.
28
+
29
+ STATE FILES (in {STATE_DIR}/):
30
+ - task.md = The original task
31
+ - work-summary.txt = What the worker claims to have done
32
+ - work-complete.txt = Exists if worker claims task is complete
33
+
34
+ REVIEW CRITERIA:
35
+ 1. Does the code/work actually accomplish the task?
36
+ 2. Does it run without errors?
37
+ 3. Is it reasonably complete (not half-done)?
38
+ 4. Are there obvious bugs or issues?
39
+
40
+ BE STRICT but FAIR:
41
+ - Don't nitpick style if functionality is correct
42
+ - DO reject incomplete work
43
+ - DO reject code that doesn't run
44
+ - DO reject if tests fail
45
+
46
+ OUTPUT (MANDATORY):
47
+ - If approved: write exactly "{VERDICT_SHIP}" to {STATE_DIR}/review-result.txt
48
+ - If needs work: write exactly "{VERDICT_REVISE}" to {STATE_DIR}/review-result.txt
49
+ AND write specific, actionable feedback to {STATE_DIR}/review-feedback.txt"""
50
+
51
+
52
+ def worker_user_prompt(iteration: int) -> str:
53
+ return f"Read {STATE_DIR}/task.md and begin working. This is iteration {iteration}."
54
+
55
+
56
+ def reviewer_user_prompt() -> str:
57
+ return (
58
+ f"Review the work done for the task in {STATE_DIR}/task.md. "
59
+ f"Examine all files, run tests, then write your verdict to {STATE_DIR}/review-result.txt"
60
+ )
ralphkit/runner.py ADDED
@@ -0,0 +1,18 @@
1
+ import subprocess
2
+
3
+
4
+ def run_claude(prompt: str, model: str, system_prompt: str) -> None:
5
+ subprocess.run(
6
+ [
7
+ "claude",
8
+ "-p",
9
+ prompt,
10
+ "--model",
11
+ model,
12
+ "--append-system-prompt",
13
+ system_prompt,
14
+ "--dangerously-skip-permissions",
15
+ ],
16
+ stdout=subprocess.DEVNULL,
17
+ check=True,
18
+ )
ralphkit/state.py ADDED
@@ -0,0 +1,50 @@
1
+ from pathlib import Path
2
+
3
+ from ralphkit.config import STATE_DIR
4
+
5
+
6
+ class StateDir:
7
+ def __init__(self, path: str | Path = STATE_DIR):
8
+ self.path = Path(path)
9
+
10
+ def setup(self) -> None:
11
+ self.path.mkdir(exist_ok=True)
12
+
13
+ def clean(self) -> None:
14
+ for name in [
15
+ "review-result.txt",
16
+ "review-feedback.txt",
17
+ "work-summary.txt",
18
+ "work-complete.txt",
19
+ "RALPH-BLOCKED.md",
20
+ ]:
21
+ (self.path / name).unlink(missing_ok=True)
22
+
23
+ def write_task(self, content: str) -> None:
24
+ (self.path / "task.md").write_text(content)
25
+
26
+ def write_iteration(self, n: int) -> None:
27
+ (self.path / "iteration.txt").write_text(str(n))
28
+
29
+ def _read(self, name: str, strip: bool = False) -> str | None:
30
+ try:
31
+ content = (self.path / name).read_text()
32
+ return content.strip() if strip else content
33
+ except FileNotFoundError:
34
+ return None
35
+
36
+ def read_review_result(self) -> str | None:
37
+ return self._read("review-result.txt", strip=True)
38
+
39
+ def read_work_summary(self) -> str | None:
40
+ return self._read("work-summary.txt")
41
+
42
+ def read_review_feedback(self) -> str | None:
43
+ return self._read("review-feedback.txt")
44
+
45
+ def is_blocked(self) -> str | None:
46
+ return self._read("RALPH-BLOCKED.md")
47
+
48
+ def clean_for_next_iteration(self) -> None:
49
+ for name in ["work-complete.txt", "review-result.txt", "work-summary.txt"]:
50
+ (self.path / name).unlink(missing_ok=True)
@@ -0,0 +1,126 @@
1
+ Metadata-Version: 2.4
2
+ Name: ralphkit
3
+ Version: 0.1.0
4
+ Summary: Iterative work/review loop for Claude Code
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Requires-Python: >=3.10
8
+ Requires-Dist: pyyaml>=6.0
9
+ Provides-Extra: dev
10
+ Requires-Dist: pytest>=7.0; extra == 'dev'
11
+ Requires-Dist: ruff>=0.4; extra == 'dev'
12
+ Description-Content-Type: text/markdown
13
+
14
+ # ralphkit
15
+
16
+ An iterative work/review loop for [Claude Code](https://docs.anthropic.com/en/docs/claude-code). One model does the work, a different model reviews it. The loop continues until the reviewer says **SHIP** or max iterations are reached.
17
+
18
+ Inspired by [Goose's Ralph pattern](https://block.github.io/goose/docs/tutorials/ralph-loop).
19
+
20
+ ## Install
21
+
22
+ ```bash
23
+ pip install ralphkit
24
+ ```
25
+
26
+ With [uv](https://docs.astral.sh/uv/):
27
+
28
+ ```bash
29
+ uv tool install ralphkit
30
+ ```
31
+
32
+ Or run directly without installing:
33
+
34
+ ```bash
35
+ uvx ralphkit ralph-loop "your task here"
36
+ ```
37
+
38
+ ## Quick Start
39
+
40
+ ```bash
41
+ ralph-loop "Create a Python function in prime.py that checks if a number is prime. Include unit tests."
42
+ ```
43
+
44
+ ## Usage
45
+
46
+ ```
47
+ ralph-loop TASK [--config PATH] [--worker-model MODEL] [--reviewer-model MODEL] [--max-iterations N] [-y]
48
+ ```
49
+
50
+ **Arguments:**
51
+
52
+ | Argument | Description | Default |
53
+ |----------|-------------|---------|
54
+ | `TASK` | Task description (string or path to `.md` file) | required |
55
+ | `--config PATH` | Load settings from a YAML config file | none |
56
+ | `--worker-model` | Model for the work phase | `opus` |
57
+ | `--reviewer-model` | Model for the review phase | `sonnet` |
58
+ | `--max-iterations` | Max work/review cycles | `10` |
59
+ | `-y` / `--yes` | Skip confirmation prompt | off |
60
+
61
+ **Examples:**
62
+
63
+ ```bash
64
+ # Inline task
65
+ ralph-loop "Build a REST API"
66
+
67
+ # Task from a markdown file
68
+ ralph-loop task.md
69
+
70
+ # Override models
71
+ ralph-loop "Build a REST API" --worker-model sonnet --reviewer-model haiku
72
+
73
+ # Use a config file for shared settings
74
+ ralph-loop "Build a REST API" --config ralph.yaml
75
+
76
+ # Skip confirmation
77
+ ralph-loop "Build a REST API" -y
78
+ ```
79
+
80
+ ### Config file
81
+
82
+ A config file is optional. When provided via `--config`, its values serve as defaults that CLI args can override.
83
+
84
+ ```yaml
85
+ # ralph.yaml
86
+ worker_model: opus
87
+ reviewer_model: sonnet
88
+ max_iterations: 10
89
+ ```
90
+
91
+ Resolution order: built-in defaults → config file → CLI args.
92
+
93
+ ## How It Works
94
+
95
+ ```
96
+ ┌─────────────────────────────────────────┐
97
+ │ 1. Read task │
98
+ │ 2. Worker model does the work │ ◄─── iteration N
99
+ │ 3. Reviewer model reviews it │
100
+ │ 4. SHIP? -> done. REVISE? -> loop. │
101
+ └─────────────────────────────────────────┘
102
+ ```
103
+
104
+ Each iteration:
105
+
106
+ 1. **Work phase** — the worker model reads the task (and any prior review feedback), writes code, runs tests, and summarizes what it did.
107
+ 2. **Review phase** — the reviewer model examines all files, runs tests, and writes either `SHIP` (approve) or `REVISE` (with feedback).
108
+ 3. If `REVISE`, the feedback is passed to the next iteration. If `SHIP`, the loop exits successfully.
109
+
110
+ ## State Files
111
+
112
+ State is persisted in `.ralphkit/` in the current working directory so each stateless `claude -p` invocation can pick up where the last left off.
113
+
114
+ | File | Purpose |
115
+ |------|---------|
116
+ | `task.md` | The task description |
117
+ | `iteration.txt` | Current iteration number |
118
+ | `work-summary.txt` | What the worker did this iteration |
119
+ | `work-complete.txt` | Created when the worker thinks it's done |
120
+ | `review-result.txt` | `SHIP` or `REVISE` |
121
+ | `review-feedback.txt` | Specific feedback from the reviewer |
122
+
123
+ ## Requirements
124
+
125
+ - [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) (`claude` must be on your PATH)
126
+ - Python 3.10+
@@ -0,0 +1,11 @@
1
+ ralphkit/__init__.py,sha256=kUR5RAFc7HCeiqdlX36dZOHkUI5wI6V_43RpEcD8b-0,22
2
+ ralphkit/cli.py,sha256=MvVm8jKNKheKlq_j5FJ_LWhYHeHD2gopuXjI40p-4cQ,7007
3
+ ralphkit/config.py,sha256=26gP-ANlpEaj6fGos5EtOsJidPXbn-id88G6ra_d2HQ,804
4
+ ralphkit/prompts.py,sha256=KXfZDeOfSc_wgs6X95vcnFw2HmllAlkoVKV5Obiefn0,2317
5
+ ralphkit/runner.py,sha256=nd35dlJBzLrBJDBX7DF4amM9kBwn2-_Xgwa8AZVJHgE,404
6
+ ralphkit/state.py,sha256=cd7loEq6xVac9xHaAnZZ0RulrdmVdG_VF0YjQh9n0tA,1551
7
+ ralphkit-0.1.0.dist-info/METADATA,sha256=Rv3G4ubO9u49hqNstlI_lGKFXjT8RIRT5UbMFKvdlKA,3827
8
+ ralphkit-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
9
+ ralphkit-0.1.0.dist-info/entry_points.txt,sha256=bUKULrHoPafQNpoxFAfZAPmz4Bm80neFPR_Q7NbVcEQ,49
10
+ ralphkit-0.1.0.dist-info/licenses/LICENSE,sha256=2yq0r8-4oRIx54qjyhflqaGrcaibvG34c_o45xvZ0jE,10763
11
+ ralphkit-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.29.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ ralph-loop = ralphkit.cli:main
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2025 Donnie Flood
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.