open-growth-loop 0.2.0__tar.gz

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.
Files changed (75) hide show
  1. open_growth_loop-0.2.0/LICENSE +201 -0
  2. open_growth_loop-0.2.0/NOTICE +4 -0
  3. open_growth_loop-0.2.0/PKG-INFO +204 -0
  4. open_growth_loop-0.2.0/README.md +176 -0
  5. open_growth_loop-0.2.0/pyproject.toml +58 -0
  6. open_growth_loop-0.2.0/setup.cfg +4 -0
  7. open_growth_loop-0.2.0/src/open_growth_loop/__init__.py +5 -0
  8. open_growth_loop-0.2.0/src/open_growth_loop/__main__.py +4 -0
  9. open_growth_loop-0.2.0/src/open_growth_loop/audit.py +558 -0
  10. open_growth_loop-0.2.0/src/open_growth_loop/candidates.py +390 -0
  11. open_growth_loop-0.2.0/src/open_growth_loop/cli.py +892 -0
  12. open_growth_loop-0.2.0/src/open_growth_loop/config.py +168 -0
  13. open_growth_loop-0.2.0/src/open_growth_loop/doctor.py +189 -0
  14. open_growth_loop-0.2.0/src/open_growth_loop/events.py +130 -0
  15. open_growth_loop-0.2.0/src/open_growth_loop/experiments.py +198 -0
  16. open_growth_loop-0.2.0/src/open_growth_loop/fix.py +218 -0
  17. open_growth_loop-0.2.0/src/open_growth_loop/freshness.py +231 -0
  18. open_growth_loop-0.2.0/src/open_growth_loop/github_evidence.py +216 -0
  19. open_growth_loop-0.2.0/src/open_growth_loop/inventory.py +51 -0
  20. open_growth_loop-0.2.0/src/open_growth_loop/io_utils.py +108 -0
  21. open_growth_loop-0.2.0/src/open_growth_loop/issue_drafts.py +155 -0
  22. open_growth_loop-0.2.0/src/open_growth_loop/memory.py +178 -0
  23. open_growth_loop-0.2.0/src/open_growth_loop/planner.py +466 -0
  24. open_growth_loop-0.2.0/src/open_growth_loop/privacy.py +147 -0
  25. open_growth_loop-0.2.0/src/open_growth_loop/prompts.py +33 -0
  26. open_growth_loop-0.2.0/src/open_growth_loop/query_backlog.py +76 -0
  27. open_growth_loop-0.2.0/src/open_growth_loop/release_brief.py +423 -0
  28. open_growth_loop-0.2.0/src/open_growth_loop/report_index.py +152 -0
  29. open_growth_loop-0.2.0/src/open_growth_loop/reporting.py +78 -0
  30. open_growth_loop-0.2.0/src/open_growth_loop/search.py +105 -0
  31. open_growth_loop-0.2.0/src/open_growth_loop/steward.py +330 -0
  32. open_growth_loop-0.2.0/src/open_growth_loop/templates/CHANGELOG.md +7 -0
  33. open_growth_loop-0.2.0/src/open_growth_loop/templates/CODE_OF_CONDUCT.md +13 -0
  34. open_growth_loop-0.2.0/src/open_growth_loop/templates/CONTRIBUTING.md +22 -0
  35. open_growth_loop-0.2.0/src/open_growth_loop/templates/ISSUE_TEMPLATE-bug_report.md +21 -0
  36. open_growth_loop-0.2.0/src/open_growth_loop/templates/ISSUE_TEMPLATE-feature_request.md +13 -0
  37. open_growth_loop-0.2.0/src/open_growth_loop/templates/LICENSE-apache-2.0.txt +201 -0
  38. open_growth_loop-0.2.0/src/open_growth_loop/templates/LICENSE-mit.txt +21 -0
  39. open_growth_loop-0.2.0/src/open_growth_loop/templates/README.md +25 -0
  40. open_growth_loop-0.2.0/src/open_growth_loop/templates/SECURITY.md +13 -0
  41. open_growth_loop-0.2.0/src/open_growth_loop/templates/ci-go.yml +16 -0
  42. open_growth_loop-0.2.0/src/open_growth_loop/templates/ci-node.yml +19 -0
  43. open_growth_loop-0.2.0/src/open_growth_loop/templates/ci-python.yml +19 -0
  44. open_growth_loop-0.2.0/src/open_growth_loop/templates/ci-rust.yml +13 -0
  45. open_growth_loop-0.2.0/src/open_growth_loop/templates/pull_request_template.md +11 -0
  46. open_growth_loop-0.2.0/src/open_growth_loop/weekly.py +290 -0
  47. open_growth_loop-0.2.0/src/open_growth_loop/workspace.py +136 -0
  48. open_growth_loop-0.2.0/src/open_growth_loop.egg-info/PKG-INFO +204 -0
  49. open_growth_loop-0.2.0/src/open_growth_loop.egg-info/SOURCES.txt +73 -0
  50. open_growth_loop-0.2.0/src/open_growth_loop.egg-info/dependency_links.txt +1 -0
  51. open_growth_loop-0.2.0/src/open_growth_loop.egg-info/entry_points.txt +2 -0
  52. open_growth_loop-0.2.0/src/open_growth_loop.egg-info/requires.txt +3 -0
  53. open_growth_loop-0.2.0/src/open_growth_loop.egg-info/top_level.txt +1 -0
  54. open_growth_loop-0.2.0/tests/test_audit.py +161 -0
  55. open_growth_loop-0.2.0/tests/test_candidates.py +144 -0
  56. open_growth_loop-0.2.0/tests/test_cli.py +74 -0
  57. open_growth_loop-0.2.0/tests/test_config.py +87 -0
  58. open_growth_loop-0.2.0/tests/test_demo.py +74 -0
  59. open_growth_loop-0.2.0/tests/test_doctor.py +64 -0
  60. open_growth_loop-0.2.0/tests/test_events.py +93 -0
  61. open_growth_loop-0.2.0/tests/test_examples.py +40 -0
  62. open_growth_loop-0.2.0/tests/test_experiments.py +146 -0
  63. open_growth_loop-0.2.0/tests/test_fix.py +154 -0
  64. open_growth_loop-0.2.0/tests/test_freshness.py +102 -0
  65. open_growth_loop-0.2.0/tests/test_github_evidence.py +84 -0
  66. open_growth_loop-0.2.0/tests/test_issue_drafts.py +95 -0
  67. open_growth_loop-0.2.0/tests/test_memory.py +55 -0
  68. open_growth_loop-0.2.0/tests/test_planner.py +200 -0
  69. open_growth_loop-0.2.0/tests/test_privacy.py +58 -0
  70. open_growth_loop-0.2.0/tests/test_prompts.py +30 -0
  71. open_growth_loop-0.2.0/tests/test_release_brief.py +124 -0
  72. open_growth_loop-0.2.0/tests/test_reports.py +137 -0
  73. open_growth_loop-0.2.0/tests/test_steward.py +86 -0
  74. open_growth_loop-0.2.0/tests/test_weekly.py +63 -0
  75. open_growth_loop-0.2.0/tests/test_workspace.py +89 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ https://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 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 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 those 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
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Open Growth Loop contributors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ https://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,4 @@
1
+ Open Growth Loop
2
+ Copyright 2026 Open Growth Loop contributors
3
+
4
+ This product includes software developed by the Open Growth Loop contributors.
@@ -0,0 +1,204 @@
1
+ Metadata-Version: 2.4
2
+ Name: open-growth-loop
3
+ Version: 0.2.0
4
+ Summary: Local-first repository stewardship with audits, safe next actions, and maintainer handoffs.
5
+ Author: R3ijar
6
+ Maintainer: R3ijar
7
+ License-Expression: Apache-2.0
8
+ Project-URL: Homepage, https://github.com/R3ijar/open-growth-loop
9
+ Project-URL: Repository, https://github.com/R3ijar/open-growth-loop
10
+ Project-URL: Issues, https://github.com/R3ijar/open-growth-loop/issues
11
+ Keywords: open-source,maintainer-tools,repository-audit,release-workflow,local-first,codex
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Environment :: Console
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Topic :: Software Development :: Quality Assurance
21
+ Classifier: Topic :: Text Processing
22
+ Requires-Python: >=3.10
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ License-File: NOTICE
26
+ Requires-Dist: tomli>=2.0.1; python_version < "3.11"
27
+ Dynamic: license-file
28
+
29
+ # Open Growth Loop
30
+
31
+ **One evidence-backed maintainer action, without another noisy bot.**
32
+
33
+ [![CI](https://github.com/R3ijar/open-growth-loop/actions/workflows/ci.yml/badge.svg)](https://github.com/R3ijar/open-growth-loop/actions/workflows/ci.yml)
34
+ [![Repository Audit](https://github.com/R3ijar/open-growth-loop/actions/workflows/audit.yml/badge.svg)](https://github.com/R3ijar/open-growth-loop/actions/workflows/audit.yml)
35
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
36
+ [![Python 3.10+](https://img.shields.io/badge/Python-3.10%2B-3776AB.svg)](pyproject.toml)
37
+ [![GitHub Release](https://img.shields.io/github/v/release/R3ijar/open-growth-loop)](https://github.com/R3ijar/open-growth-loop/releases/latest)
38
+
39
+ Open Growth Loop answers one question for maintainers: **what deserves attention next, and what evidence supports it?**
40
+
41
+ Point it at any repository and it combines repository hygiene with local Git state into one maintainer brief. It can preview safe scaffolds for mechanical gaps, hand judgment-heavy work to an agent, and defer to real issue or pull-request demand when the local repository already looks healthy. Local-only mode needs no account or API key and sends nothing away; an explicit `--github owner/repo` flag can add a bounded, read-only snapshot through the authenticated GitHub CLI.
42
+
43
+ ![Open Growth Loop maintainer workflow](docs/assets/open-growth-loop-system-v013.svg)
44
+
45
+ ## Quickstart
46
+
47
+ ```bash
48
+ pip install git+https://github.com/R3ijar/open-growth-loop
49
+ ogl audit --workspace path/to/your-repo
50
+ ogl steward --workspace path/to/your-repo
51
+ ogl steward --workspace path/to/your-repo --no-write # read-only JSON decision
52
+ ogl steward --workspace path/to/your-repo --github owner/repo # opt-in live public evidence
53
+ ```
54
+
55
+ Thirty seconds later, `outbox/audit/latest-audit.md` holds a scorecard over 14 hygiene checks — README quality, license, install and quickstart onboarding, docs, examples, community files, changelog, CI, and release-tag cadence:
56
+
57
+ | Check | Category | Status | Detail |
58
+ | --- | --- | --- | --- |
59
+ | README | essentials | PASS | README is present with enough content to evaluate the project. |
60
+ | License | essentials | PASS | A license file is present. |
61
+ | Quickstart | onboarding | WARN | README has no usage section with a copy-pasteable example. |
62
+ | Continuous integration | automation | WARN | No CI configuration was found; contributors cannot see whether tests pass. |
63
+ | Release tags | release | PASS | Latest tag is v1.3.0. |
64
+
65
+ *...plus nine more checks, and then the part that matters:*
66
+
67
+ | Field | Value |
68
+ | --- | --- |
69
+ | Action | Add a Quickstart section with one runnable example and its expected output. |
70
+ | Why now | README has no usage section with a copy-pasteable example. |
71
+ | Confidence | medium |
72
+
73
+ Every audit recommends exactly **one next action**, ordered by how much each gap hurts a new visitor, with a step checklist and a Codex-ready prompt — so the next focused change is one paste away. Reports stay local; add `outbox/` to your `.gitignore` if you don't want to keep them.
74
+
75
+ And when the gap is mechanical, you don't even have to write the file:
76
+
77
+ ```bash
78
+ ogl fix --workspace path/to/your-repo # scaffold the recommended action
79
+ ogl fix --workspace path/to/your-repo --license mit # licenses need an explicit choice
80
+ ```
81
+
82
+ `ogl fix` scaffolds missing community files, changelogs, licenses, issue/PR templates, and an ecosystem-detected starter CI workflow — with TODO markers, never overwriting anything. Checks that need real judgment (README content, docs, quickstart) hand you the Codex prompt instead. A bare repository typically goes from 0% to ~70% with fixes alone; the rest is writing worth doing yourself.
83
+
84
+ ## Use It With Codex
85
+
86
+ The repository includes an installable [`repo-steward` skill](skills/repo-steward/SKILL.md). It tells Codex to begin with local evidence, check live maintainer demand when available, choose exactly one bounded action, and keep pushes, releases, merges, comments, and other remote mutations behind explicit approval.
87
+
88
+ Invoke it with a request such as:
89
+
90
+ ```text
91
+ Use $repo-steward to inspect this repository and complete the safest evidence-backed maintainer action.
92
+ ```
93
+
94
+ The skill uses `ogl steward` as its evidence packet and can opt in to `--github owner/repo` when current public issues, pull requests, CI runs, and releases should influence the decision. All GitHub commands are reads; the CLI remains useful without an agent or network access.
95
+
96
+ ## Maintainer Field Test
97
+
98
+ Open Growth Loop needs counterexamples more than endorsements. If you maintain a public repository, run `ogl steward --no-write` and tell us where its selected action was wrong. The [20-minute field test](docs/ADOPTION.md) has a structured feedback form and does not require a call or ongoing commitment.
99
+
100
+ ## Use It As A GitHub Action
101
+
102
+ Add one workflow file and the audit runs on every push, straight into the Actions job summary:
103
+
104
+ ```yaml
105
+ name: Repository Audit
106
+ on:
107
+ push:
108
+ branches: [main]
109
+
110
+ jobs:
111
+ audit:
112
+ runs-on: ubuntu-latest
113
+ steps:
114
+ - uses: actions/checkout@v4
115
+ with:
116
+ fetch-depth: 0
117
+ - uses: R3ijar/open-growth-loop@main
118
+ ```
119
+
120
+ The action exposes `ok` and `score-percent` outputs and an optional `strict` gate that fails the job when README or LICENSE is missing. Full reference: [docs/GITHUB_ACTION.md](docs/GITHUB_ACTION.md). This repository [runs it on itself](.github/workflows/audit.yml).
121
+
122
+ ## The Full Loop
123
+
124
+ The audit covers hygiene; the loop plans from evidence. Drop privacy-safe CSV exports into `data/` — Search Console rows, aggregate event counts (`date,asset,event,count` only), a content inventory, an experiment ledger — and Open Growth Loop turns them into one conservative daily action:
125
+
126
+ ```bash
127
+ ogl init --workspace . # create the data files
128
+ ogl validate --workspace . # schema and privacy-safe header checks
129
+ ogl plan --workspace . # one action, fully explained
130
+ ```
131
+
132
+ ```json
133
+ {
134
+ "action_type": "release_evidence",
135
+ "asset": "/guides/configuration-checklist",
136
+ "confidence": "high",
137
+ "reason": "Staged work should be proven public before creating another asset."
138
+ }
139
+ ```
140
+
141
+ Each plan ships with a **decision trace** (what won, what lost and why, which thresholds applied) and a **data freshness** report (whether the inputs deserve trust). Completed work and its later outcomes feed back into ranking, so the loop learns locally. Browse real generated reports in the [report gallery](docs/REPORT_GALLERY.md).
142
+
143
+ ### Planner Engine Coverage
144
+
145
+ Candidates are ranked across the maintainer surfaces that shape OSS adoption, in deliberately conservative priority order:
146
+
147
+ 1. **Release evidence** — prove staged docs, examples, or package pages are actually public before starting anything new.
148
+ 2. **Outcome memory** — record what happened to completed work before repeating it.
149
+ 3. **Funnel dropoff** — public pages with enough views but weak install, try, or next-step clicks.
150
+ 4. **Search opportunities** — near-ranking pages and low-CTR queries from Search Console exports.
151
+ 5. **Planned assets** — the next queued guide or page, only when stronger signals are absent.
152
+
153
+ Weak evidence is labeled insufficient instead of being spun into a win. The goal is less thrash, not a content treadmill.
154
+
155
+ ## Commands
156
+
157
+ | Command | What it does |
158
+ | --- | --- |
159
+ | `ogl audit` | Zero-config repository readiness scorecard with one recommended action. |
160
+ | `ogl steward` | Combine the audit, local Git state, and optional read-only GitHub evidence into one maintainer brief. |
161
+ | `ogl fix` | Scaffold the recommended action when it is mechanical; hand off a Codex prompt when it is not. |
162
+ | `ogl init` / `ogl validate` | Create and check the local data CSVs. |
163
+ | `ogl doctor` | One-shot readiness report across validation, freshness, privacy, planning, and release review. |
164
+ | `ogl demo` | Generate the complete report set in one run. |
165
+ | `ogl freshness` | Warn when local inputs are too stale to trust. |
166
+ | `ogl candidates` / `ogl plan` | Rank every considered action; select one with a full decision trace. |
167
+ | `ogl prompt` / `ogl issue-drafts` | Turn the plan into a Codex-ready prompt or a reviewable issue draft. |
168
+ | `ogl complete` / `ogl outcome` | Record what was done and what happened, so ranking learns locally. |
169
+ | `ogl track-experiment` / `ogl ship` / `ogl review-experiments` | Baseline, ship, and conservatively review changes. |
170
+ | `ogl weekly-review` / `ogl query-backlog` / `ogl report-index` | Operating summaries and the report front page. |
171
+ | `ogl privacy-scan` | Check local files for private-data leakage before sharing. |
172
+
173
+ Full walkthroughs, data schemas, thresholds, and column aliases live in the [usage guide](docs/USAGE.md).
174
+
175
+ ## Privacy Boundary
176
+
177
+ Open Growth Loop is designed around aggregate inputs. The event importer accepts only `date,asset,event,count` and rejects private-looking columns such as email, user, session, ip, payload, token, or secret. Local-only commands never upload analytics or project files. The optional `steward --github owner/repo` adapter calls `gh` only for repository metadata and never writes, comments, labels, merges, closes, or publishes. The project never claims a change worked from tiny samples or missing artifacts.
178
+
179
+ ## Documentation
180
+
181
+ - [Usage guide](docs/USAGE.md) — installation, every command, data files, configuration, and decision rules.
182
+ - [GitHub Action reference](docs/GITHUB_ACTION.md) — inputs, outputs, strict mode, and scheduled audits.
183
+ - [Example workflow](docs/EXAMPLE_WORKFLOW.md) — a full walkthrough with the bundled sample CSVs.
184
+ - [Report gallery](docs/REPORT_GALLERY.md) — what the generated reports look like.
185
+ - [Runnable examples](examples/README.md) — five synthetic workspaces with documented expected plans.
186
+ - [Dogfooding](docs/DOGFOODING.md) — how this repository maintains itself with its own loop.
187
+ - [Public compatibility study](docs/COMPATIBILITY_STUDY.md) — a transparent ten-repository run, including two defects it exposed and the limits of the evidence.
188
+ - [Adoption and design partners](docs/ADOPTION.md) — run a field test and share verifiable feedback.
189
+ - [Releasing](docs/RELEASING.md) — the tag-driven PyPI release process.
190
+ - [Roadmap](ROADMAP.md) and [Changelog](CHANGELOG.md).
191
+
192
+ ## Project Status
193
+
194
+ Version on `main`: v0.2.0. See [GitHub Releases](https://github.com/R3ijar/open-growth-loop/releases) for the latest published version. The project is early and is actively seeking maintainer design partners. The zero-config audit, steward brief, fix scaffolds, and GitHub Action are ready for field testing; the CSV-driven loop remains available for small maintainer workflows.
195
+
196
+ ## Contributing
197
+
198
+ Issues and pull requests are welcome — [CONTRIBUTING.md](CONTRIBUTING.md) covers setup and expectations, and [docs/NEXT_ISSUES.md](docs/NEXT_ISSUES.md) lists good starting points. Please keep private product data and unverifiable adoption claims out of examples and docs; `ogl privacy-scan` and the release-brief guardrails exist for exactly that.
199
+
200
+ Open Growth Loop is maintained by [@R3ijar](https://github.com/R3ijar), who owns scope, releases, and final review. See the [design-partner outreach playbook](docs/OUTREACH.md) for the public feedback process.
201
+
202
+ ## License
203
+
204
+ [Apache-2.0](LICENSE)
@@ -0,0 +1,176 @@
1
+ # Open Growth Loop
2
+
3
+ **One evidence-backed maintainer action, without another noisy bot.**
4
+
5
+ [![CI](https://github.com/R3ijar/open-growth-loop/actions/workflows/ci.yml/badge.svg)](https://github.com/R3ijar/open-growth-loop/actions/workflows/ci.yml)
6
+ [![Repository Audit](https://github.com/R3ijar/open-growth-loop/actions/workflows/audit.yml/badge.svg)](https://github.com/R3ijar/open-growth-loop/actions/workflows/audit.yml)
7
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
8
+ [![Python 3.10+](https://img.shields.io/badge/Python-3.10%2B-3776AB.svg)](pyproject.toml)
9
+ [![GitHub Release](https://img.shields.io/github/v/release/R3ijar/open-growth-loop)](https://github.com/R3ijar/open-growth-loop/releases/latest)
10
+
11
+ Open Growth Loop answers one question for maintainers: **what deserves attention next, and what evidence supports it?**
12
+
13
+ Point it at any repository and it combines repository hygiene with local Git state into one maintainer brief. It can preview safe scaffolds for mechanical gaps, hand judgment-heavy work to an agent, and defer to real issue or pull-request demand when the local repository already looks healthy. Local-only mode needs no account or API key and sends nothing away; an explicit `--github owner/repo` flag can add a bounded, read-only snapshot through the authenticated GitHub CLI.
14
+
15
+ ![Open Growth Loop maintainer workflow](docs/assets/open-growth-loop-system-v013.svg)
16
+
17
+ ## Quickstart
18
+
19
+ ```bash
20
+ pip install git+https://github.com/R3ijar/open-growth-loop
21
+ ogl audit --workspace path/to/your-repo
22
+ ogl steward --workspace path/to/your-repo
23
+ ogl steward --workspace path/to/your-repo --no-write # read-only JSON decision
24
+ ogl steward --workspace path/to/your-repo --github owner/repo # opt-in live public evidence
25
+ ```
26
+
27
+ Thirty seconds later, `outbox/audit/latest-audit.md` holds a scorecard over 14 hygiene checks — README quality, license, install and quickstart onboarding, docs, examples, community files, changelog, CI, and release-tag cadence:
28
+
29
+ | Check | Category | Status | Detail |
30
+ | --- | --- | --- | --- |
31
+ | README | essentials | PASS | README is present with enough content to evaluate the project. |
32
+ | License | essentials | PASS | A license file is present. |
33
+ | Quickstart | onboarding | WARN | README has no usage section with a copy-pasteable example. |
34
+ | Continuous integration | automation | WARN | No CI configuration was found; contributors cannot see whether tests pass. |
35
+ | Release tags | release | PASS | Latest tag is v1.3.0. |
36
+
37
+ *...plus nine more checks, and then the part that matters:*
38
+
39
+ | Field | Value |
40
+ | --- | --- |
41
+ | Action | Add a Quickstart section with one runnable example and its expected output. |
42
+ | Why now | README has no usage section with a copy-pasteable example. |
43
+ | Confidence | medium |
44
+
45
+ Every audit recommends exactly **one next action**, ordered by how much each gap hurts a new visitor, with a step checklist and a Codex-ready prompt — so the next focused change is one paste away. Reports stay local; add `outbox/` to your `.gitignore` if you don't want to keep them.
46
+
47
+ And when the gap is mechanical, you don't even have to write the file:
48
+
49
+ ```bash
50
+ ogl fix --workspace path/to/your-repo # scaffold the recommended action
51
+ ogl fix --workspace path/to/your-repo --license mit # licenses need an explicit choice
52
+ ```
53
+
54
+ `ogl fix` scaffolds missing community files, changelogs, licenses, issue/PR templates, and an ecosystem-detected starter CI workflow — with TODO markers, never overwriting anything. Checks that need real judgment (README content, docs, quickstart) hand you the Codex prompt instead. A bare repository typically goes from 0% to ~70% with fixes alone; the rest is writing worth doing yourself.
55
+
56
+ ## Use It With Codex
57
+
58
+ The repository includes an installable [`repo-steward` skill](skills/repo-steward/SKILL.md). It tells Codex to begin with local evidence, check live maintainer demand when available, choose exactly one bounded action, and keep pushes, releases, merges, comments, and other remote mutations behind explicit approval.
59
+
60
+ Invoke it with a request such as:
61
+
62
+ ```text
63
+ Use $repo-steward to inspect this repository and complete the safest evidence-backed maintainer action.
64
+ ```
65
+
66
+ The skill uses `ogl steward` as its evidence packet and can opt in to `--github owner/repo` when current public issues, pull requests, CI runs, and releases should influence the decision. All GitHub commands are reads; the CLI remains useful without an agent or network access.
67
+
68
+ ## Maintainer Field Test
69
+
70
+ Open Growth Loop needs counterexamples more than endorsements. If you maintain a public repository, run `ogl steward --no-write` and tell us where its selected action was wrong. The [20-minute field test](docs/ADOPTION.md) has a structured feedback form and does not require a call or ongoing commitment.
71
+
72
+ ## Use It As A GitHub Action
73
+
74
+ Add one workflow file and the audit runs on every push, straight into the Actions job summary:
75
+
76
+ ```yaml
77
+ name: Repository Audit
78
+ on:
79
+ push:
80
+ branches: [main]
81
+
82
+ jobs:
83
+ audit:
84
+ runs-on: ubuntu-latest
85
+ steps:
86
+ - uses: actions/checkout@v4
87
+ with:
88
+ fetch-depth: 0
89
+ - uses: R3ijar/open-growth-loop@main
90
+ ```
91
+
92
+ The action exposes `ok` and `score-percent` outputs and an optional `strict` gate that fails the job when README or LICENSE is missing. Full reference: [docs/GITHUB_ACTION.md](docs/GITHUB_ACTION.md). This repository [runs it on itself](.github/workflows/audit.yml).
93
+
94
+ ## The Full Loop
95
+
96
+ The audit covers hygiene; the loop plans from evidence. Drop privacy-safe CSV exports into `data/` — Search Console rows, aggregate event counts (`date,asset,event,count` only), a content inventory, an experiment ledger — and Open Growth Loop turns them into one conservative daily action:
97
+
98
+ ```bash
99
+ ogl init --workspace . # create the data files
100
+ ogl validate --workspace . # schema and privacy-safe header checks
101
+ ogl plan --workspace . # one action, fully explained
102
+ ```
103
+
104
+ ```json
105
+ {
106
+ "action_type": "release_evidence",
107
+ "asset": "/guides/configuration-checklist",
108
+ "confidence": "high",
109
+ "reason": "Staged work should be proven public before creating another asset."
110
+ }
111
+ ```
112
+
113
+ Each plan ships with a **decision trace** (what won, what lost and why, which thresholds applied) and a **data freshness** report (whether the inputs deserve trust). Completed work and its later outcomes feed back into ranking, so the loop learns locally. Browse real generated reports in the [report gallery](docs/REPORT_GALLERY.md).
114
+
115
+ ### Planner Engine Coverage
116
+
117
+ Candidates are ranked across the maintainer surfaces that shape OSS adoption, in deliberately conservative priority order:
118
+
119
+ 1. **Release evidence** — prove staged docs, examples, or package pages are actually public before starting anything new.
120
+ 2. **Outcome memory** — record what happened to completed work before repeating it.
121
+ 3. **Funnel dropoff** — public pages with enough views but weak install, try, or next-step clicks.
122
+ 4. **Search opportunities** — near-ranking pages and low-CTR queries from Search Console exports.
123
+ 5. **Planned assets** — the next queued guide or page, only when stronger signals are absent.
124
+
125
+ Weak evidence is labeled insufficient instead of being spun into a win. The goal is less thrash, not a content treadmill.
126
+
127
+ ## Commands
128
+
129
+ | Command | What it does |
130
+ | --- | --- |
131
+ | `ogl audit` | Zero-config repository readiness scorecard with one recommended action. |
132
+ | `ogl steward` | Combine the audit, local Git state, and optional read-only GitHub evidence into one maintainer brief. |
133
+ | `ogl fix` | Scaffold the recommended action when it is mechanical; hand off a Codex prompt when it is not. |
134
+ | `ogl init` / `ogl validate` | Create and check the local data CSVs. |
135
+ | `ogl doctor` | One-shot readiness report across validation, freshness, privacy, planning, and release review. |
136
+ | `ogl demo` | Generate the complete report set in one run. |
137
+ | `ogl freshness` | Warn when local inputs are too stale to trust. |
138
+ | `ogl candidates` / `ogl plan` | Rank every considered action; select one with a full decision trace. |
139
+ | `ogl prompt` / `ogl issue-drafts` | Turn the plan into a Codex-ready prompt or a reviewable issue draft. |
140
+ | `ogl complete` / `ogl outcome` | Record what was done and what happened, so ranking learns locally. |
141
+ | `ogl track-experiment` / `ogl ship` / `ogl review-experiments` | Baseline, ship, and conservatively review changes. |
142
+ | `ogl weekly-review` / `ogl query-backlog` / `ogl report-index` | Operating summaries and the report front page. |
143
+ | `ogl privacy-scan` | Check local files for private-data leakage before sharing. |
144
+
145
+ Full walkthroughs, data schemas, thresholds, and column aliases live in the [usage guide](docs/USAGE.md).
146
+
147
+ ## Privacy Boundary
148
+
149
+ Open Growth Loop is designed around aggregate inputs. The event importer accepts only `date,asset,event,count` and rejects private-looking columns such as email, user, session, ip, payload, token, or secret. Local-only commands never upload analytics or project files. The optional `steward --github owner/repo` adapter calls `gh` only for repository metadata and never writes, comments, labels, merges, closes, or publishes. The project never claims a change worked from tiny samples or missing artifacts.
150
+
151
+ ## Documentation
152
+
153
+ - [Usage guide](docs/USAGE.md) — installation, every command, data files, configuration, and decision rules.
154
+ - [GitHub Action reference](docs/GITHUB_ACTION.md) — inputs, outputs, strict mode, and scheduled audits.
155
+ - [Example workflow](docs/EXAMPLE_WORKFLOW.md) — a full walkthrough with the bundled sample CSVs.
156
+ - [Report gallery](docs/REPORT_GALLERY.md) — what the generated reports look like.
157
+ - [Runnable examples](examples/README.md) — five synthetic workspaces with documented expected plans.
158
+ - [Dogfooding](docs/DOGFOODING.md) — how this repository maintains itself with its own loop.
159
+ - [Public compatibility study](docs/COMPATIBILITY_STUDY.md) — a transparent ten-repository run, including two defects it exposed and the limits of the evidence.
160
+ - [Adoption and design partners](docs/ADOPTION.md) — run a field test and share verifiable feedback.
161
+ - [Releasing](docs/RELEASING.md) — the tag-driven PyPI release process.
162
+ - [Roadmap](ROADMAP.md) and [Changelog](CHANGELOG.md).
163
+
164
+ ## Project Status
165
+
166
+ Version on `main`: v0.2.0. See [GitHub Releases](https://github.com/R3ijar/open-growth-loop/releases) for the latest published version. The project is early and is actively seeking maintainer design partners. The zero-config audit, steward brief, fix scaffolds, and GitHub Action are ready for field testing; the CSV-driven loop remains available for small maintainer workflows.
167
+
168
+ ## Contributing
169
+
170
+ Issues and pull requests are welcome — [CONTRIBUTING.md](CONTRIBUTING.md) covers setup and expectations, and [docs/NEXT_ISSUES.md](docs/NEXT_ISSUES.md) lists good starting points. Please keep private product data and unverifiable adoption claims out of examples and docs; `ogl privacy-scan` and the release-brief guardrails exist for exactly that.
171
+
172
+ Open Growth Loop is maintained by [@R3ijar](https://github.com/R3ijar), who owns scope, releases, and final review. See the [design-partner outreach playbook](docs/OUTREACH.md) for the public feedback process.
173
+
174
+ ## License
175
+
176
+ [Apache-2.0](LICENSE)
@@ -0,0 +1,58 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "open-growth-loop"
7
+ version = "0.2.0"
8
+ description = "Local-first repository stewardship with audits, safe next actions, and maintainer handoffs."
9
+ readme = "README.md"
10
+ requires-python = ">=3.10"
11
+ license = "Apache-2.0"
12
+ authors = [
13
+ { name = "R3ijar" }
14
+ ]
15
+ maintainers = [
16
+ { name = "R3ijar" }
17
+ ]
18
+ keywords = ["open-source", "maintainer-tools", "repository-audit", "release-workflow", "local-first", "codex"]
19
+ classifiers = [
20
+ "Development Status :: 3 - Alpha",
21
+ "Environment :: Console",
22
+ "Intended Audience :: Developers",
23
+ "Programming Language :: Python :: 3",
24
+ "Programming Language :: Python :: 3.10",
25
+ "Programming Language :: Python :: 3.11",
26
+ "Programming Language :: Python :: 3.12",
27
+ "Programming Language :: Python :: 3.13",
28
+ "Topic :: Software Development :: Quality Assurance",
29
+ "Topic :: Text Processing"
30
+ ]
31
+ dependencies = [
32
+ "tomli>=2.0.1; python_version < '3.11'"
33
+ ]
34
+
35
+ [project.urls]
36
+ Homepage = "https://github.com/R3ijar/open-growth-loop"
37
+ Repository = "https://github.com/R3ijar/open-growth-loop"
38
+ Issues = "https://github.com/R3ijar/open-growth-loop/issues"
39
+
40
+ [project.scripts]
41
+ ogl = "open_growth_loop.cli:main"
42
+
43
+ [tool.setuptools.packages.find]
44
+ where = ["src"]
45
+
46
+ [tool.setuptools.package-data]
47
+ open_growth_loop = ["templates/*"]
48
+
49
+ [tool.pytest.ini_options]
50
+ pythonpath = ["src"]
51
+ testpaths = ["tests"]
52
+
53
+ [tool.ruff]
54
+ line-length = 160
55
+ target-version = "py310"
56
+
57
+ [tool.ruff.lint]
58
+ select = ["E4", "E7", "E9", "F", "I", "B", "UP"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,5 @@
1
+ """Open Growth Loop package."""
2
+
3
+ __all__ = ["__version__"]
4
+
5
+ __version__ = "0.2.0"