emkeel 0.1.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 (40) hide show
  1. emkeel-0.1.0/.gitattributes +5 -0
  2. emkeel-0.1.0/.github/workflows/ci.yml +45 -0
  3. emkeel-0.1.0/.github/workflows/jira-transition.yml +27 -0
  4. emkeel-0.1.0/.github/workflows/release.yml +30 -0
  5. emkeel-0.1.0/.gitignore +9 -0
  6. emkeel-0.1.0/AGENTS.md +27 -0
  7. emkeel-0.1.0/CLAUDE.md +1 -0
  8. emkeel-0.1.0/LICENSE +202 -0
  9. emkeel-0.1.0/NOTICE +5 -0
  10. emkeel-0.1.0/PKG-INFO +36 -0
  11. emkeel-0.1.0/README.md +23 -0
  12. emkeel-0.1.0/docs/install.md +49 -0
  13. emkeel-0.1.0/docs/lifecycle.md +22 -0
  14. emkeel-0.1.0/docs/review-assist.md +28 -0
  15. emkeel-0.1.0/emkeel-governance/adr/0001-adopt-and-thin.md +39 -0
  16. emkeel-0.1.0/emkeel-governance/adr/0002-license-apache-2.0.md +26 -0
  17. emkeel-0.1.0/emkeel-governance/specs/KEEL-10.md +23 -0
  18. emkeel-0.1.0/emkeel-governance/specs/KEEL-11.md +23 -0
  19. emkeel-0.1.0/emkeel-governance/specs/KEEL-2.md +19 -0
  20. emkeel-0.1.0/emkeel-governance/specs/KEEL-3.md +22 -0
  21. emkeel-0.1.0/emkeel-governance/specs/KEEL-4.md +22 -0
  22. emkeel-0.1.0/emkeel-governance/specs/KEEL-5.md +25 -0
  23. emkeel-0.1.0/emkeel-governance/specs/KEEL-6.md +24 -0
  24. emkeel-0.1.0/emkeel-governance/specs/KEEL-7.md +25 -0
  25. emkeel-0.1.0/emkeel-governance/specs/KEEL-8.md +21 -0
  26. emkeel-0.1.0/pyproject.toml +24 -0
  27. emkeel-0.1.0/src/emkeel/__init__.py +3 -0
  28. emkeel-0.1.0/src/emkeel/gates/__init__.py +5 -0
  29. emkeel-0.1.0/src/emkeel/gates/check_acceptance_criteria.py +66 -0
  30. emkeel-0.1.0/src/emkeel/gates/check_plan_present.py +55 -0
  31. emkeel-0.1.0/src/emkeel/gates/check_ticket_link.py +43 -0
  32. emkeel-0.1.0/src/emkeel/init.py +254 -0
  33. emkeel-0.1.0/src/emkeel/jira.py +97 -0
  34. emkeel-0.1.0/src/emkeel/review.py +79 -0
  35. emkeel-0.1.0/tests/test_check_acceptance_criteria.py +47 -0
  36. emkeel-0.1.0/tests/test_check_plan_present.py +52 -0
  37. emkeel-0.1.0/tests/test_check_ticket_link.py +19 -0
  38. emkeel-0.1.0/tests/test_init.py +98 -0
  39. emkeel-0.1.0/tests/test_jira.py +65 -0
  40. emkeel-0.1.0/tests/test_review.py +51 -0
@@ -0,0 +1,5 @@
1
+ # SEPARACIÓN — un solo límite físico:
2
+ # TODO lo que Emkeel genera (ADRs, specs, records) vive en emkeel-governance/.
3
+ # Esa única carpeta se excluye de la distribución (tarball / mirror code-only).
4
+ # Borra esa carpeta para separar artefactos del código; sálvala para respaldarlos.
5
+ emkeel-governance/ export-ignore
@@ -0,0 +1,45 @@
1
+ name: emkeel-ci
2
+
3
+ on:
4
+ pull_request:
5
+ push:
6
+ branches: [main]
7
+
8
+ jobs:
9
+ gates:
10
+ runs-on: ubuntu-latest
11
+ steps:
12
+ - uses: actions/checkout@v4
13
+ - uses: actions/setup-python@v5
14
+ with:
15
+ python-version: "3.12"
16
+
17
+ - name: Install
18
+ run: pip install -e ".[dev]"
19
+
20
+ # Gate: el PR debe referenciar un ticket (trazabilidad ticket->codigo).
21
+ # Solo aplica en pull_request (en push directo a main no hay PR title).
22
+ - name: "Gate — ticket link"
23
+ if: github.event_name == 'pull_request'
24
+ env:
25
+ EMKEEL_BRANCH: ${{ github.head_ref }}
26
+ EMKEEL_PR_TITLE: ${{ github.event.pull_request.title }}
27
+ run: python -m emkeel.gates.check_ticket_link
28
+
29
+ # Gate: un PR feature (rama feat/) debe traer su spec en emkeel-governance/specs/.
30
+ - name: "Gate — plan present (features)"
31
+ if: github.event_name == 'pull_request'
32
+ env:
33
+ EMKEEL_BRANCH: ${{ github.head_ref }}
34
+ run: python -m emkeel.gates.check_plan_present
35
+
36
+ # Gate: un spec de feature debe declarar Acceptance Criteria.
37
+ - name: "Gate — acceptance criteria (features)"
38
+ if: github.event_name == 'pull_request'
39
+ env:
40
+ EMKEEL_BRANCH: ${{ github.head_ref }}
41
+ run: python -m emkeel.gates.check_acceptance_criteria
42
+
43
+ # Gate: la suite completa de tests (memoria durable anti-regresión).
44
+ - name: "Gate — tests"
45
+ run: pytest -q
@@ -0,0 +1,27 @@
1
+ name: jira-transition
2
+
3
+ # Post-merge automation (NOT a gate): when a PR merges, move its linked ticket to Done.
4
+ on:
5
+ pull_request:
6
+ types: [closed]
7
+
8
+ jobs:
9
+ transition:
10
+ if: github.event.pull_request.merged == true
11
+ runs-on: ubuntu-latest
12
+ steps:
13
+ - uses: actions/checkout@v4
14
+ - uses: actions/setup-python@v5
15
+ with:
16
+ python-version: "3.12"
17
+ - name: Install emkeel
18
+ run: pip install -e .
19
+ - name: Transition linked ticket to Done
20
+ continue-on-error: true # best-effort; never block on a Jira hiccup
21
+ env:
22
+ JIRA_BASE_URL: ${{ secrets.JIRA_BASE_URL }}
23
+ JIRA_EMAIL: ${{ secrets.JIRA_EMAIL }}
24
+ JIRA_TOKEN: ${{ secrets.JIRA_TOKEN }}
25
+ EMKEEL_BRANCH: ${{ github.head_ref }}
26
+ EMKEEL_PR_TITLE: ${{ github.event.pull_request.title }}
27
+ run: python -m emkeel.jira
@@ -0,0 +1,30 @@
1
+ name: release
2
+
3
+ # Publish emkeel to PyPI on a GitHub Release (or manual dispatch).
4
+ # Uses PyPI Trusted Publishing (OIDC) — NO token stored. Configure the trusted
5
+ # publisher on PyPI once: Project → Publishing → add this repo + workflow "release.yml".
6
+ on:
7
+ release:
8
+ types: [published]
9
+ workflow_dispatch:
10
+
11
+ permissions:
12
+ contents: read
13
+
14
+ jobs:
15
+ pypi-publish:
16
+ runs-on: ubuntu-latest
17
+ permissions:
18
+ contents: read # actions/checkout needs this (job-level perms replace the full set)
19
+ id-token: write # required for OIDC Trusted Publishing
20
+ steps:
21
+ - uses: actions/checkout@v4
22
+ - uses: actions/setup-python@v5
23
+ with:
24
+ python-version: "3.12"
25
+ - name: Build wheel + sdist
26
+ run: |
27
+ python -m pip install --upgrade build
28
+ python -m build
29
+ - name: Publish to PyPI (Trusted Publishing)
30
+ uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,9 @@
1
+ __pycache__/
2
+ *.pyc
3
+ .pytest_cache/
4
+ .ruff_cache/
5
+ dist/
6
+ build/
7
+ *.egg-info/
8
+ .venv/
9
+ venv/
emkeel-0.1.0/AGENTS.md ADDED
@@ -0,0 +1,27 @@
1
+ # AGENTS.md — Contrato del agente (Emkeel)
2
+
3
+ Eres un **ejecutor bajo gates deterministas**. Las reglas que importan NO viven en
4
+ este archivo (es best-effort y se puede ignorar); viven en **CI + branch protection**,
5
+ que no puedes saltarte. Si algo se puede saltar, no es un gate: es una sugerencia.
6
+
7
+ ## Ciclo de un cambio
8
+
9
+ 1. Una rama por ticket: `feature/<KEY-123>-slug`.
10
+ 2. Produce los artefactos del cambio: plan (si es feature) → código → tests.
11
+ 3. **Todo fix de bug empieza por un test que lo reproduce** (queda como regresión permanente).
12
+ 4. Abre PR. El merge requiere: **CI verde + aprobación humana + ticket ligado**.
13
+ 5. ¿Decisión arquitectónica? Un ADR en `emkeel-governance/adr/`.
14
+
15
+ ## Reglas duras (las enforza CI, no este archivo)
16
+
17
+ - La **suite completa** corre en cada PR. Si rompes algo viejo → CI rojo → no mergeas.
18
+ - Commits: **Conventional Commits** con la KEY del ticket.
19
+ - Prohibido `--no-verify`. Prohibido marcar "done" sin que el check lo compute.
20
+
21
+ ## Separación (estructural, no negociable)
22
+
23
+ - `src/emkeel/` = código distribuible.
24
+ - `emkeel-governance/` = la ÚNICA carpeta de artefactos (ADR/specs/records). **Nunca** se
25
+ distribuye (`export-ignore`). Es el único límite físico: borrarla = código limpio.
26
+
27
+ > Nota: Claude Code lee `CLAUDE.md` (symlink → este archivo).
emkeel-0.1.0/CLAUDE.md ADDED
@@ -0,0 +1 @@
1
+ AGENTS.md
emkeel-0.1.0/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
emkeel-0.1.0/NOTICE ADDED
@@ -0,0 +1,5 @@
1
+ Emkeel
2
+ Copyright 2026 EMillion Networking LTD
3
+
4
+ This product includes software developed at EMillion Networking LTD.
5
+ Licensed under the Apache License, Version 2.0 (see LICENSE).
emkeel-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,36 @@
1
+ Metadata-Version: 2.4
2
+ Name: emkeel
3
+ Version: 0.1.0
4
+ Summary: Adopt-and-thin SDLC governance framework
5
+ Author: EMillion Networking LTD
6
+ License: Apache-2.0
7
+ License-File: LICENSE
8
+ License-File: NOTICE
9
+ Requires-Python: >=3.11
10
+ Provides-Extra: dev
11
+ Requires-Dist: pytest>=8; extra == 'dev'
12
+ Description-Content-Type: text/markdown
13
+
14
+ # Emkeel
15
+
16
+ Framework de gobernanza SDLC — **adopt-and-thin**. La quilla sobre la que se
17
+ construyen proyectos paso a paso: trazables, sin regresiones, con la IA como
18
+ ejecutor bajo gates deterministas.
19
+
20
+ ## Principio central
21
+
22
+ > **"done" = hecho computado** (el artefacto existe + pasa un check determinista),
23
+ > nunca un flag auto-atestado. El enforcement vive **server-side** (CI + branch
24
+ > protection), fuera del alcance del agente. Pocos gates duros + un gate humano.
25
+
26
+ ## Cómo está organizado (separación estructural, día 1)
27
+
28
+ - `src/emkeel/` — **código distribuible** (lo único que se empaqueta).
29
+ - `emkeel-governance/` — **la única carpeta de artefactos** (ADR / specs / records). Un
30
+ solo límite físico: `export-ignore` la excluye del paquete/tarball. Borra esa carpeta
31
+ para separar artefactos del código; sálvala para respaldarlos. Nada más que separar.
32
+
33
+ Ver `AGENTS.md` (contrato del agente) y `docs/lifecycle.md` (la convención).
34
+
35
+ ---
36
+ Licensed under **Apache-2.0** — © 2026 EMillion Networking LTD (ver `LICENSE` / `NOTICE`).
emkeel-0.1.0/README.md ADDED
@@ -0,0 +1,23 @@
1
+ # Emkeel
2
+
3
+ Framework de gobernanza SDLC — **adopt-and-thin**. La quilla sobre la que se
4
+ construyen proyectos paso a paso: trazables, sin regresiones, con la IA como
5
+ ejecutor bajo gates deterministas.
6
+
7
+ ## Principio central
8
+
9
+ > **"done" = hecho computado** (el artefacto existe + pasa un check determinista),
10
+ > nunca un flag auto-atestado. El enforcement vive **server-side** (CI + branch
11
+ > protection), fuera del alcance del agente. Pocos gates duros + un gate humano.
12
+
13
+ ## Cómo está organizado (separación estructural, día 1)
14
+
15
+ - `src/emkeel/` — **código distribuible** (lo único que se empaqueta).
16
+ - `emkeel-governance/` — **la única carpeta de artefactos** (ADR / specs / records). Un
17
+ solo límite físico: `export-ignore` la excluye del paquete/tarball. Borra esa carpeta
18
+ para separar artefactos del código; sálvala para respaldarlos. Nada más que separar.
19
+
20
+ Ver `AGENTS.md` (contrato del agente) y `docs/lifecycle.md` (la convención).
21
+
22
+ ---
23
+ Licensed under **Apache-2.0** — © 2026 EMillion Networking LTD (ver `LICENSE` / `NOTICE`).
@@ -0,0 +1,49 @@
1
+ # Installing Emkeel in a repo
2
+
3
+ `emkeel init` scaffolds a target repo to be governed by Emkeel. It is **non-clobbering**
4
+ (existing files are skipped unless `--force`) and **never writes secrets**.
5
+
6
+ ## Run
7
+
8
+ ```bash
9
+ # Dry-run first (writes nothing, shows the plan):
10
+ python -m emkeel.init /path/to/repo \
11
+ --jira-url https://your.atlassian.net \
12
+ --jira-project KEY \
13
+ --github-repo owner/repo \
14
+ --dry-run
15
+
16
+ # Then for real:
17
+ python -m emkeel.init /path/to/repo --jira-url ... --jira-project KEY --github-repo owner/repo
18
+ ```
19
+
20
+ ### Install source (private emkeel)
21
+
22
+ The generated CI runs `pip install <source>`. **Default:** the PyPI package, version-pinned
23
+ (`emkeel~=0.1.0`) — `pip install emkeel`, no account, no token.
24
+
25
+ For a **private fork**, pass a git+token form and add the token as a repo secret:
26
+
27
+ ```bash
28
+ python -m emkeel.init /path/to/repo ... \
29
+ --emkeel-source 'git+https://x-access-token:${EMKEEL_INSTALL_TOKEN}@github.com/OWNER/emkeel.git'
30
+ ```
31
+
32
+ Then add `EMKEEL_INSTALL_TOKEN` (a fine-grained PAT with READ access to the emkeel repo)
33
+ as a GitHub Actions secret in the target repo.
34
+
35
+ ## What it creates
36
+
37
+ - `emkeel-governance/{specs,adr,records}/` — the single artifact folder (`export-ignore`).
38
+ - `.github/workflows/emkeel-ci.yml` — runs the gates on PRs.
39
+ - `emkeel.toml` — non-secret config (Jira URL + project key, GitHub repo).
40
+ - `.env.example` — secrets template (real `.env` is gitignored, never committed).
41
+ - `AGENTS.md` — the agent contract (skipped if one already exists).
42
+
43
+ ## Connect (one-time, printed by the command)
44
+
45
+ 1. **GitHub for Jira** app → install & link the repo (commits/PRs link to tickets).
46
+ 2. **Branch protection** on `main` → require the `gates` check + a PR.
47
+ 3. **Secrets** → add `JIRA_TOKEN` (+ `JIRA_EMAIL`) as GitHub Actions secrets.
48
+ 4. **Local** → `cp .env.example .env` and fill it.
49
+ 5. **Install source** → until Emkeel is on PyPI, point the CI `Install emkeel` line at your source.
@@ -0,0 +1,22 @@
1
+ # Lifecycle (lean)
2
+
3
+ ```
4
+ rama → artefactos → PR → gates → merge
5
+ ```
6
+
7
+ | Paso | Artefacto | Gate (server-side, no falsificable) |
8
+ |---|---|---|
9
+ | plan | `emkeel-governance/specs/<KEY>.md` (solo features) | CI: existe + valida |
10
+ | develop | código + tests | CI: lint + types + **suite completa** verde |
11
+ | verify | (CI) + tu review | required check + required approval |
12
+ | decisión | `emkeel-governance/adr/NNNN-*.md` | CI: ADR presente si toca zona marcada |
13
+ | merge | — | branch protection: CI verde + approval + ticket ligado |
14
+
15
+ ## Por qué funciona
16
+
17
+ - **"done" = el check pasa**, no un flag que el agente escribe. (Con LangGraph y sin
18
+ LangGraph el agente se saltaba reglas porque eran auto-atestadas; el orquestador
19
+ nunca fue la variable — el locus de autoridad sí.)
20
+ - La **suite de tests es la memoria durable** anti-regresión: el agente olvida entre
21
+ sesiones, la suite no. Re-romper algo viejo = CI rojo = bloqueado.
22
+ - Lo no-mecanizable lo cubre **tu gate humano** (aprobar el PR), no más prosa.
@@ -0,0 +1,28 @@
1
+ # Review-assist (advisory)
2
+
3
+ After CI is green and before the human merges: a per-criterion review. It reduces the
4
+ reviewer's blind spot (useful when you can't read the code deeply) — but it is
5
+ **advisory, never a gate**. The human is the final approver; the AI never merges.
6
+
7
+ ## Steps
8
+
9
+ 1. **Gather inputs.** `python -m emkeel.review <KEY>` prints a template with the
10
+ ticket's Acceptance Criteria, one section each. Get the diff with `gh pr diff <N>`.
11
+ 2. **Verdict per criterion.** For each `AC1..ACn`, the reviewer (AI and/or human) fills:
12
+ - `verdict:` met / not-met / unsure
13
+ - `evidence:` the file/lines in the diff that show it
14
+ 3. **Concerns.** List anything outside the criteria worth flagging (design, risk).
15
+ 4. **Ratchet.** Any criterion not backed by a test → file a test. Judgment you make
16
+ once becomes a permanent deterministic check (so next time the machine guards it).
17
+ 5. **Human approves.** Read the filled template, then merge. The AI never merges.
18
+
19
+ ## Why advisory, not a gate
20
+
21
+ AI judgment is probabilistic — a non-deterministic CI gate would reintroduce the very
22
+ fragility Emkeel removes. So the layers are:
23
+
24
+ - **CI / gates (deterministic floor)** — tests, linters: cannot be faked.
25
+ - **Review-assist (advisory)** — shrinks the human's blind spot, criterion by criterion.
26
+ - **Human (final approver)** — judgment + merge.
27
+
28
+ What the review-assist proves with a test, it hands down to the deterministic floor.
@@ -0,0 +1,39 @@
1
+ # 1. Emkeel adopta gobernanza adopt-and-thin
2
+
3
+ - Estado: aceptado
4
+ - Fecha: 2026-06-06
5
+ - Deciders: operador (EMillion Networking)
6
+
7
+ ## Contexto
8
+
9
+ El framework v1 (`em-development-framework`, engine LangGraph bespoke) se volvió
10
+ insostenible para un solo dev: cada escalado se desorganizaba (footgun de `--work-impl=stub`,
11
+ replan W69, scope drift 4×). Un research de mercado (deep-research, 2026-06-06, verificado
12
+ adversarialmente) confirmó el consenso: para un equipo solo/diminuto se **componen
13
+ herramientas off-the-shelf**, no se construye un framework bespoke (el anti-patrón).
14
+
15
+ ## Decisión
16
+
17
+ Emkeel compone: **GitHub** (branch protection + Actions CI), **Jira** (workflow),
18
+ **Conventional Commits**, **ADRs markdown**, y **Claude Code** (skills/subagents/hooks +
19
+ AGENTS.md). El único código propio es una capa fina: **gates deterministas** + el patrón
20
+ **Plan-Execute-Verify** + el pegamento **ADR↔sesión** (trazabilidad spec a largo plazo,
21
+ brecha no resuelta del mercado). `"done"` = hecho computado; enforcement server-side;
22
+ pocos gates duros + gate humano.
23
+
24
+ ## Consecuencias
25
+
26
+ - v1 **congelado** (cantera read-only). W70/W71 **cancelados**.
27
+ - **Separación estructural día 1**: `src/` (distribuible) vs `emkeel-governance/` (la única
28
+ carpeta de artefactos, `export-ignore`). Un solo límite físico. Nunca más un cutover.
29
+ - **Anti-regresión**: test-on-fix + CI corre la suite completa en cada PR.
30
+
31
+ ## Alternativas consideradas
32
+
33
+ - Seguir parchando v1 → rechazado (arrastra errores).
34
+ - Reconstruir otro engine bespoke → rechazado (*second-system trap*).
35
+
36
+ ## Referencias
37
+
38
+ - Research de mercado (deep-research, 2026-06-06).
39
+ - Memoria del operador: `project-emkeel-v2-pivot`.
@@ -0,0 +1,26 @@
1
+ # 2. Emkeel is licensed Apache-2.0 (free / open-source)
2
+
3
+ - Status: accepted
4
+ - Date: 2026-06-07
5
+ - Deciders: operator (EMillion Networking)
6
+
7
+ ## Context
8
+ Emkeel started under a provisional proprietary license. The operator decided to
9
+ distribute it **free / open-source first** (adoption now; monetize later via open-core).
10
+ A permissive OSS license also removes the private-package friction: once on PyPI,
11
+ `pip install emkeel` works for anyone — no install token.
12
+
13
+ ## Decision
14
+ License Emkeel under **Apache-2.0**. Chosen over MIT for its explicit **patent grant**
15
+ (safer for a tool that may be commercialized later). The repos Emkeel *governs* stay
16
+ private — only the framework itself is public.
17
+
18
+ ## Consequences
19
+ - `LICENSE` replaced (proprietary → Apache-2.0 verbatim) + `NOTICE` added.
20
+ - `pyproject.toml` declares Apache-2.0.
21
+ - Distribution path opens: PyPI (public), `pip install emkeel`, no token.
22
+ - Re-licensable by the copyright holder; contributions covered by Apache-2.0 §5.
23
+
24
+ ## Alternatives considered
25
+ - **MIT** — simpler, but no explicit patent grant.
26
+ - **Stay proprietary** — blocks free distribution and keeps the install-token friction.
@@ -0,0 +1,23 @@
1
+ # KEEL-10 — Installer default to public git source
2
+
3
+ ## Context
4
+ Emkeel is now public + tagged `v0.1.0`, so a governed repo can install it token-less from
5
+ the public repo. The installer's default `--emkeel-source` should reflect that (the prior
6
+ default `emkeel~=…` won't resolve until PyPI exists).
7
+
8
+ ## Plan
9
+ - `src/emkeel/init.py` — `_default_source()` returns `git+<public-repo>@v{__version__}`
10
+ (token-less, tag-pinned, tracks version bumps).
11
+ - `tests/test_init.py` — assert the default is the public git URL pinned to `@v{version}`.
12
+ - `docs/install.md` — document the public-git default; PyPI/private-fork as alternatives.
13
+
14
+ ## Acceptance Criteria
15
+ - `emkeel init` (no `--emkeel-source`) generates CI installing from
16
+ `git+https://github.com/.../emkeel.git@v0.1.0` — public, no token.
17
+ - The pin tracks `__version__` (`@v{version}`), so a release/tag bump updates the default.
18
+ - A custom `--emkeel-source` (PyPI spec or private git+token) still overrides.
19
+ - The default needs no secret (no `EMKEEL_INSTALL_TOKEN`).
20
+
21
+ ## Anti-regression
22
+ - Tests cover: default is public git + tag-pinned (`@v{version}`), never bare; custom
23
+ source still flows through; checklist mentions the token only for private sources.
@@ -0,0 +1,23 @@
1
+ # KEEL-11 — PyPI release workflow + installer default to PyPI
2
+
3
+ ## Context
4
+ Model A chosen: repo stays PRIVATE (governance hidden), distribute the PACKAGE on PyPI
5
+ (public). This adds the release pipeline and reverts the installer default to the PyPI
6
+ pin (KEEL-10's public-git default is superseded — the repo is private again).
7
+
8
+ ## Plan
9
+ - `.github/workflows/release.yml` — on a GitHub Release (or manual dispatch), build
10
+ wheel+sdist and publish to PyPI via **Trusted Publishing (OIDC, no token)**.
11
+ - `src/emkeel/init.py` — `_default_source()` returns `emkeel~=0.{minor}.0` (PyPI pin),
12
+ not the git URL. Private fork still overridable via `--emkeel-source`.
13
+ - `tests/test_init.py` + `docs/install.md` — assert/document the PyPI default.
14
+
15
+ ## Acceptance Criteria
16
+ - `emkeel init` (no `--emkeel-source`) generates CI with `pip install "emkeel~=0.1.0"`.
17
+ - `release.yml` builds and publishes via Trusted Publishing (`id-token: write`, the
18
+ `pypa/gh-action-pypi-publish` action) — no PyPI token stored in the repo.
19
+ - A custom `--emkeel-source` (private git+token) still overrides.
20
+ - The release workflow ships only in emkeel's own repo (NOT scaffolded into governed repos).
21
+
22
+ ## Anti-regression
23
+ - Tests cover: default source is the PyPI pin (`emkeel~=`), never bare; custom source overrides.
@@ -0,0 +1,19 @@
1
+ # KEEL-2 — Gate: plan-presence para features
2
+
3
+ ## Contexto
4
+ Primer ticket dogfood: el primer cambio real que recorre el loop de Emkeel
5
+ (rama → PR → gates CI → merge). Añade el segundo gate determinista.
6
+
7
+ ## Plan
8
+ - `src/emkeel/gates/check_plan_present.py` — el gate: una rama `feat/` exige
9
+ `emkeel-governance/specs/<KEY>.md`; otros tipos no.
10
+ - `tests/test_check_plan_present.py` — su test (test-on-fix desde el día 1).
11
+ - `.github/workflows/ci.yml` — nuevo step que corre el gate en PRs.
12
+
13
+ ## Verificación
14
+ - `pytest` verde (incluye el nuevo test).
15
+ - Auto-validación: este PR es `feat/KEEL-2-...`, así que el gate corre sobre sí mismo
16
+ y exige este mismo spec → debe pasar porque el archivo existe.
17
+
18
+ ## Anti-regresión
19
+ - El test cubre: feature requiere spec, no-feature no, y detección de spec presente.