get-engineering-done 0.1.0__tar.gz

get_engineering_done-0.1.0/LICENSE

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

get_engineering_done-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+prune tests
+prune internal
+prune artifacts
+prune scripts
+prune docs
+prune .github
+exclude AGENT.md
+global-exclude *.pyc
+global-exclude __pycache__

get_engineering_done-0.1.0/PKG-INFO

@@ -0,0 +1,192 @@
+Metadata-Version: 2.4
+Name: get-engineering-done
+Version: 0.1.0
+Summary: Get Engineering Done: structured agentic workflows for engineering programs
+Author: Englund Garage
+License-Expression: Apache-2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-timeout>=2.3; extra == "dev"
+Provides-Extra: mutation
+Requires-Dist: mutmut<3,>=2.4; extra == "mutation"
+Requires-Dist: coverage>=7; extra == "mutation"
+Dynamic: license-file
+
+# Get Engineering Done (GED)
+
+Get Engineering Done is a command-workflow scaffold for engineering programs
+that need more structure than a one-off chat or notebook. It is
+engineering-specific from the start.
+
+GED provides a complete engineering workflow command surface and capability
+set. It targets capability completeness: every capability an engineering
+program needs to go from objective to reviewable, verified package has an
+explicit home in GED.
+
+GED turns an engineering objective into a reviewable workflow:
+
+```text
+formulate -> architect -> plan -> execute -> verify -> package
+```
+
+The first goal is not to fake a solver or a green result. The first goal is to
+make an engineering project reviewable: requirements, interfaces, discipline
+models, solver evidence, verification verdicts, provenance, and acceptance
+criteria all have explicit homes.
+
+## Quick Start
+
+From a source checkout, install the runtime command surface with the Node
+bootstrapper:
+
+```bash
+node bin/install.js --codex --local
+```
+
+Use `--claude`, `--gemini`, `--opencode`, or `--all` for the other supported
+runtimes. The installer writes model-visible GED command files into the selected
+runtime config target.
+
+> **Planned (post-npm-publish):** once `get-engineering-done` ships to npm,
+> the source-checkout step will be replaceable with
+> `npx -y get-engineering-done --codex --local`. The package is not yet
+> published — see [capability tracker](https://github.com/Englund-Garage/get-engineering-done/issues/27)
+> for the runtime-install capability that this depends on.
+
+Install the Python CLI:
+
+```bash
+python3.11 -m venv .venv
+source .venv/bin/activate
+python -m pip install -e .
+ged --help
+```
+
+Create a draft engineering project:
+
+```bash
+ged new-project \
+  --root /path/to/project \
+  --objective "Produce a coupled coherent PIC transceiver model" \
+  --domain "photonic transceiver engineering"
+```
+
+Validate the scaffold:
+
+```bash
+ged validate --root /path/to/project
+```
+
+Strict validation is intentionally harder. A new scaffold is a draft; it does
+not pass strict validation until phase artifacts are present, nonempty,
+format-checked, marked available in the phase manifest, and paired with
+matching hash/provenance metadata. Strict validation does not prove engineering
+truth; it checks that a package is reviewable and not an obvious placeholder.
+
+```bash
+ged validate --root /path/to/project --strict
+```
+
+## Runtime Commands
+
+GED is designed to expose the same command loop across AI runtimes:
+
+| Runtime | Help | New project |
+| --- | --- | --- |
+| Codex | `$ged-help` | `$ged-new-project` |
+| Claude Code | `/ged:help` | `/ged:new-project` |
+| Gemini CLI | `/ged:help` | `/ged:new-project` |
+| OpenCode | `/ged-help` | `/ged-new-project` |
+
+The local CLI can print the full command map:
+
+```bash
+ged command-map --runtime codex
+```
+
+## Capability completeness
+
+GED tracks its engineering capability set as an executable requirement:
+
+```bash
+ged capabilities
+```
+
+This command returns non-zero until every required engineering capability is
+present. See [docs/capability-requirement.md](docs/capability-requirement.md).
+
+## Template Curation (STEM)
+
+GED can curate STEM-ready templates for agent use and emit Neo4j-shared ingest
+artifacts:
+
+```bash
+# --workspace-root defaults to the current working directory; --output-root
+# defaults to ./artifacts/template-curation
+ged curate-templates
+```
+
+Or with explicit paths:
+
+```bash
+ged curate-templates \
+  --workspace-root /path/to/workspace \
+  --output-root /path/to/output
+```
+
+Install a 30-minute launchd schedule (macOS):
+
+```bash
+ged install-curation-schedule \
+  --workspace-root /path/to/workspace \
+  --output-root /path/to/output \
+  --interval-minutes 30
+```
+
+The plist defaults to
+`~/Library/LaunchAgents/com.englund-garage.ged.template-curator.plist`;
+override with `--plist-path` if you prefer a different location.
+
+## Project Shape
+
+GED creates:
+
+```text
+GED/
+  PROJECT.md
+  REQUIREMENTS.md
+  ROADMAP.md
+  STATE.md
+  phases/
+    phase-01/
+      PLAN.md
+      VERIFY.md
+      outputs/
+        README.md
+        artifact_manifest.json
+```
+
+The manifest starts with planned artifacts only. Real engineering outputs must
+be added by the owning project before the phase can move from draft to green.
+
+## Engineering Bias
+
+GED is for engineering programs where success depends on interfaces,
+tolerances, physical constraints, cost or manufacturability, simulation
+evidence, tests, and reviewable provenance. For the initial coherent PIC
+transceiver use case, GED should sit above OpenMDAO/MPhys, discipline backends
+such as Tidy3D/SAX/SPICE/gdsfactory/Femwell, VVUQ claim checks, Neo4j
+provenance, and work-contract acceptance gates.
+
+## Development
+
+```bash
+python3.11 -m pytest -q
+```

get_engineering_done-0.1.0/README.md

@@ -0,0 +1,171 @@
+# Get Engineering Done (GED)
+
+Get Engineering Done is a command-workflow scaffold for engineering programs
+that need more structure than a one-off chat or notebook. It is
+engineering-specific from the start.
+
+GED provides a complete engineering workflow command surface and capability
+set. It targets capability completeness: every capability an engineering
+program needs to go from objective to reviewable, verified package has an
+explicit home in GED.
+
+GED turns an engineering objective into a reviewable workflow:
+
+```text
+formulate -> architect -> plan -> execute -> verify -> package
+```
+
+The first goal is not to fake a solver or a green result. The first goal is to
+make an engineering project reviewable: requirements, interfaces, discipline
+models, solver evidence, verification verdicts, provenance, and acceptance
+criteria all have explicit homes.
+
+## Quick Start
+
+From a source checkout, install the runtime command surface with the Node
+bootstrapper:
+
+```bash
+node bin/install.js --codex --local
+```
+
+Use `--claude`, `--gemini`, `--opencode`, or `--all` for the other supported
+runtimes. The installer writes model-visible GED command files into the selected
+runtime config target.
+
+> **Planned (post-npm-publish):** once `get-engineering-done` ships to npm,
+> the source-checkout step will be replaceable with
+> `npx -y get-engineering-done --codex --local`. The package is not yet
+> published — see [capability tracker](https://github.com/Englund-Garage/get-engineering-done/issues/27)
+> for the runtime-install capability that this depends on.
+
+Install the Python CLI:
+
+```bash
+python3.11 -m venv .venv
+source .venv/bin/activate
+python -m pip install -e .
+ged --help
+```
+
+Create a draft engineering project:
+
+```bash
+ged new-project \
+  --root /path/to/project \
+  --objective "Produce a coupled coherent PIC transceiver model" \
+  --domain "photonic transceiver engineering"
+```
+
+Validate the scaffold:
+
+```bash
+ged validate --root /path/to/project
+```
+
+Strict validation is intentionally harder. A new scaffold is a draft; it does
+not pass strict validation until phase artifacts are present, nonempty,
+format-checked, marked available in the phase manifest, and paired with
+matching hash/provenance metadata. Strict validation does not prove engineering
+truth; it checks that a package is reviewable and not an obvious placeholder.
+
+```bash
+ged validate --root /path/to/project --strict
+```
+
+## Runtime Commands
+
+GED is designed to expose the same command loop across AI runtimes:
+
+| Runtime | Help | New project |
+| --- | --- | --- |
+| Codex | `$ged-help` | `$ged-new-project` |
+| Claude Code | `/ged:help` | `/ged:new-project` |
+| Gemini CLI | `/ged:help` | `/ged:new-project` |
+| OpenCode | `/ged-help` | `/ged-new-project` |
+
+The local CLI can print the full command map:
+
+```bash
+ged command-map --runtime codex
+```
+
+## Capability completeness
+
+GED tracks its engineering capability set as an executable requirement:
+
+```bash
+ged capabilities
+```
+
+This command returns non-zero until every required engineering capability is
+present. See [docs/capability-requirement.md](docs/capability-requirement.md).
+
+## Template Curation (STEM)
+
+GED can curate STEM-ready templates for agent use and emit Neo4j-shared ingest
+artifacts:
+
+```bash
+# --workspace-root defaults to the current working directory; --output-root
+# defaults to ./artifacts/template-curation
+ged curate-templates
+```
+
+Or with explicit paths:
+
+```bash
+ged curate-templates \
+  --workspace-root /path/to/workspace \
+  --output-root /path/to/output
+```
+
+Install a 30-minute launchd schedule (macOS):
+
+```bash
+ged install-curation-schedule \
+  --workspace-root /path/to/workspace \
+  --output-root /path/to/output \
+  --interval-minutes 30
+```
+
+The plist defaults to
+`~/Library/LaunchAgents/com.englund-garage.ged.template-curator.plist`;
+override with `--plist-path` if you prefer a different location.
+
+## Project Shape
+
+GED creates:
+
+```text
+GED/
+  PROJECT.md
+  REQUIREMENTS.md
+  ROADMAP.md
+  STATE.md
+  phases/
+    phase-01/
+      PLAN.md
+      VERIFY.md
+      outputs/
+        README.md
+        artifact_manifest.json
+```
+
+The manifest starts with planned artifacts only. Real engineering outputs must
+be added by the owning project before the phase can move from draft to green.
+
+## Engineering Bias
+
+GED is for engineering programs where success depends on interfaces,
+tolerances, physical constraints, cost or manufacturability, simulation
+evidence, tests, and reviewable provenance. For the initial coherent PIC
+transceiver use case, GED should sit above OpenMDAO/MPhys, discipline backends
+such as Tidy3D/SAX/SPICE/gdsfactory/Femwell, VVUQ claim checks, Neo4j
+provenance, and work-contract acceptance gates.
+
+## Development
+
+```bash
+python3.11 -m pytest -q
+```

get_engineering_done-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "get-engineering-done"
+version = "0.1.0"
+description = "Get Engineering Done: structured agentic workflows for engineering programs"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+authors = [
+  { name = "Englund Garage" }
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Science/Research",
+  "Programming Language :: Python :: 3.11",
+  "Topic :: Scientific/Engineering"
+]
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8",
+  "pytest-timeout>=2.3"
+]
+# Mutation testing (issue #44). Advisory only — see scripts/mutmut_kill_rate.py
+# and CLAUDE.md "Mutation testing". Kept separate from `dev` so the core test
+# job stays lean; the mutation CI job installs `.[mutation]`.
+mutation = [
+  "mutmut>=2.4,<3",
+  "coverage>=7"
+]
+
+[project.scripts]
+ged = "ged.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+ged = ["adapters/*.json", "agents/*.md", "commands/*.md", "core/*.json", "static/*.css"]
+
+[tool.pytest.ini_options]
+addopts = "-q"
+pythonpath = ["src", "."]
+testpaths = ["tests"]
+timeout = 30

get_engineering_done-0.1.0/setup.cfg

@@ -0,0 +1,9 @@
+[mutmut]
+paths_to_mutate = src/ged/marimo_panels.py
+tests_dir = tests/
+runner = python -m pytest -x -q --no-header -p no:cacheprovider tests/test_marimo_panels.py tests/test_marimo_panels_architecture.py tests/test_marimo_panels_sota_behavioral.py tests/test_marimo_panels_mutation_killers.py
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

get_engineering_done-0.1.0/src/ged/__init__.py

@@ -0,0 +1,3 @@
+"""Get Engineering Done core package."""
+
+__version__ = "0.1.0"

get_engineering_done-0.1.0/src/ged/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from .cli import main
+
+
+raise SystemExit(main())

get_engineering_done-0.1.0/src/ged/adapters/runtime_catalog.json

@@ -0,0 +1,76 @@
+[
+  {
+    "runtime_name": "claude-code",
+    "display_name": "Claude Code",
+    "priority": 10,
+    "config_dir_name": ".claude",
+    "install_flag": "--claude",
+    "launch_command": "claude",
+    "command_prefix": "/ged:",
+    "selection_flags": ["--claude-code", "--claude"],
+    "selection_aliases": ["claude-code", "claude code", "claude"],
+    "managed_install_surface": {
+      "nested_command_dir": "commands/ged"
+    },
+    "global_config": {
+      "env_var": "CLAUDE_CONFIG_DIR",
+      "home_subpath": ".claude"
+    }
+  },
+  {
+    "runtime_name": "gemini",
+    "display_name": "Gemini CLI",
+    "priority": 20,
+    "config_dir_name": ".gemini",
+    "install_flag": "--gemini",
+    "launch_command": "gemini",
+    "command_prefix": "/ged:",
+    "selection_flags": ["--gemini", "--gemini-cli"],
+    "selection_aliases": ["gemini", "gemini cli"],
+    "managed_install_surface": {
+      "nested_command_dir": "commands/ged"
+    },
+    "global_config": {
+      "env_var": "GEMINI_CONFIG_DIR",
+      "home_subpath": ".gemini"
+    }
+  },
+  {
+    "runtime_name": "codex",
+    "display_name": "Codex",
+    "priority": 30,
+    "config_dir_name": ".codex",
+    "install_flag": "--codex",
+    "launch_command": "codex",
+    "command_prefix": "$ged-",
+    "selection_flags": ["--codex"],
+    "selection_aliases": ["codex"],
+    "managed_install_surface": {
+      "skill_dir": "skills",
+      "skill_prefix": "ged-"
+    },
+    "global_config": {
+      "env_var": "CODEX_CONFIG_DIR",
+      "home_subpath": ".codex"
+    }
+  },
+  {
+    "runtime_name": "opencode",
+    "display_name": "OpenCode",
+    "priority": 40,
+    "config_dir_name": ".opencode",
+    "install_flag": "--opencode",
+    "launch_command": "opencode",
+    "command_prefix": "/ged-",
+    "selection_flags": ["--opencode"],
+    "selection_aliases": ["opencode", "open code"],
+    "managed_install_surface": {
+      "flat_command_dir": "command",
+      "file_prefix": "ged-"
+    },
+    "global_config": {
+      "env_var": "OPENCODE_CONFIG_DIR",
+      "home_subpath": ".config/opencode"
+    }
+  }
+]