devspec 0.1.0__py3-none-any.whl

devspec-0.1.0.dist-info/METADATA

@@ -0,0 +1,522 @@
+Metadata-Version: 2.4
+Name: devspec
+Version: 0.1.0
+Summary: Installer and synchronizer CLI for the devspec workflow framework.
+Author: devspec contributors
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+Keywords: agents,ai,developer-tools,spec-driven-development,workflow
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# devspec
+
+`devspec` is a spec-driven development framework for teams using GitHub Copilot and other AI coding agents.
+
+It stores planning, implementation, review, and recovery state in Git-tracked files instead of relying on chat history.
+
+Use it when you want agents to follow the same workflow for:
+
+- project context, architecture, engineering rules, and coding standards
+- feature, bug, and security work-item intake
+- clarification, finalization, task planning, implementation, and review
+- session recovery from repository artifacts
+
+## Quick Start
+
+Install with the `devspec` CLI. The recommended one-off path is `uvx`, which avoids a permanent global install and works well on machines where developers cannot write to shared PATH folders.
+
+For install, workflow, AI coding agent, multi-repo, provider, validation, and upgrade examples, see [`docs/how-to/README.md`](docs/how-to/README.md).
+
+1. Open the target repository in VS Code or the selected AI coding tool.
+2. Install all supported adapter files into the repository:
+
+   ```text
+   uvx devspec init --target . --profile all --repo-state existing
+   ```
+
+   Use `--repo-state new` for a new repository.
+
+3. Validate the install:
+
+   ```text
+   uvx devspec doctor --target . --profile all
+   ```
+
+4. Commit the copied files.
+5. Run the foundation flow for a new or existing repository.
+6. Start the first work item.
+
+Manual copy remains supported as a fallback when package managers are blocked. Copy the framework folders listed in [Manual Copy Fallback](#manual-copy-fallback), then commit the copied files.
+
+For a new project:
+
+```text
+/devspec.projectcontext
+/devspec.techstack
+/devspec.codebase-structure
+/devspec.coding-standards
+/devspec.rules
+```
+
+For an existing project:
+
+```text
+/devspec.extract
+/devspec.projectcontext
+/devspec.techstack
+/devspec.codebase-structure
+/devspec.coding-standards
+/devspec.rules
+```
+
+Then run the work-item flow:
+
+```text
+/devspec.story
+/devspec.finalize
+/devspec.tasks
+/devspec.implement
+/devspec.review
+```
+
+Use `/devspec.clarify` only when a work item records a blocking question. Use `/devspec.diagram` when a diagram would clarify architecture, workflow, state, sequence, or domain behavior.
+
+## How It Works
+
+`devspec` has two workflow layers.
+
+| Layer | Purpose | Commands |
+| --- | --- | --- |
+| Foundation | Capture stable project context, architecture, stack, structure, standards, and rules. | `/devspec.extract`, `/devspec.projectcontext`, `/devspec.techstack`, `/devspec.codebase-structure`, `/devspec.coding-standards`, `/devspec.rules` |
+| Work items | Move one feature, bug, or security issue from intake to review. | `/devspec.story`, `/devspec.clarify`, `/devspec.finalize`, `/devspec.tasks`, `/devspec.implement`, `/devspec.review` |
+
+```mermaid
+flowchart TD
+    Start["Start"] --> State{"Project state?"}
+    State -- "new" --> ProjectContext["/devspec.projectcontext"]
+    State -- "existing" --> Extract["/devspec.extract"]
+    Extract --> ProjectContext
+    ProjectContext --> TechStack["/devspec.techstack"]
+    TechStack --> Structure["/devspec.codebase-structure"]
+    Structure --> Standards["/devspec.coding-standards"]
+    Standards --> Rules["/devspec.rules"]
+    Rules --> Story["/devspec.story"]
+    Story --> Blocked{"Blocking question?"}
+    Blocked -- "yes" --> Clarify["/devspec.clarify"]
+    Clarify --> Story
+    Blocked -- "no" --> Finalize["/devspec.finalize"]
+    Finalize --> Ready{"Ready?"}
+    Ready -- "no" --> Clarify
+    Ready -- "yes" --> Tasks["/devspec.tasks"]
+    Tasks --> Implement["/devspec.implement"]
+    Implement --> Review["/devspec.review"]
+    Review --> Outcome{"Review outcome?"}
+    Outcome -- "changes requested" --> Implement
+    Outcome -- "approved" --> Done["Done"]
+```
+
+## Command Reference
+
+| Command | Use when | Main output |
+| --- | --- | --- |
+| `/devspec.extract` | Existing code/docs should seed the foundation. | Foundation, architecture, extraction, and diagram queue artifacts. |
+| `/devspec.projectcontext` | Product and business context must be recorded. | `devspec/foundation/project-context.md` |
+| `/devspec.techstack` | Stack, runtime, hosting, tooling, or support status must be recorded. | `devspec/foundation/tech-stack.md` |
+| `/devspec.codebase-structure` | Repository layout, boundaries, multi-repo access, or integration contracts must be recorded. | `devspec/foundation/codebase-structure.md` |
+| `/devspec.coding-standards` | Engineering standards and observed patterns must be recorded. | `devspec/foundation/coding-standards.md` |
+| `/devspec.rules` | Operational rules, compliance requirements, and gates must be recorded. | `devspec/foundation/rules.md` |
+| `/devspec.story` | A feature, bug, security issue, task, PBI, or provider reference needs intake. | Work-item `meta.md`, `story.md`, `decisions.md`, `notes.md` |
+| `/devspec.clarify` | A blocking question must be resolved. | Work-item `clarify.md` |
+| `/devspec.finalize` | A work item needs an implementation-ready brief. | Work-item `finalize.md` |
+| `/devspec.tasks` | A ready brief needs executable tasks. | Work-item `tasks.md` |
+| `/devspec.implement` | Pending tasks should be implemented and recorded. | Work-item `implement.md` and code changes when applicable |
+| `/devspec.review` | Implemented work needs review against the finalized brief. | Work-item `review.md` |
+| `/devspec.diagram` | A diagram should be created or updated. | Architecture or work-item Mermaid diagram artifacts |
+
+For exact command contracts, see `devspec/adapters/command-registry.md`.
+
+## AI Tool Support
+
+GitHub Copilot prompt and agent files are the reference implementation. Other adapters are thin wrappers around the same command registry and Git-tracked artifacts.
+
+| Tool | Files | Notes |
+| --- | --- | --- |
+| GitHub Copilot | `.github/prompts/`, `.github/agents/` | Native `/devspec.*` command implementation. |
+| Claude Code | `.claude/skills/devspec-*/SKILL.md` | Project skills for canonical commands. |
+| OpenAI Codex | `AGENTS.md`, `devspec/adapters/codex.md` | Repository instructions and Codex guidance. |
+| Cursor | `.cursor/rules/devspec-workflow.mdc`, `AGENTS.md` | Project rules plus shared fallback instructions. |
+| Gemini CLI | `GEMINI.md`, optional `.gemini/commands/devspec/*.toml` | `GEMINI.md` is enough for context; TOML files only add native `/devspec:*` shortcuts. |
+| Google Antigravity | `.agents/rules/devspec-workflow.md`, `.agents/skills/devspec-*.md` | Workspace rule and skills using `/devspec-*` names. |
+
+Canonical command names remain `/devspec.*`. Some adapters expose host-native shortcuts such as `/devspec:story` or `/devspec-story`.
+
+Related docs:
+
+- [`docs/how-to/README.md`](docs/how-to/README.md)
+- [`devspec/adapters/README.md`](devspec/adapters/README.md)
+- [`devspec/adapters/compatibility-matrix.md`](devspec/adapters/compatibility-matrix.md)
+- [`devspec/adapters/validation-flows.md`](devspec/adapters/validation-flows.md)
+- [`devspec/adapters/enterprise-governance.md`](devspec/adapters/enterprise-governance.md)
+
+## Repository Layout
+
+| Path | Purpose |
+| --- | --- |
+| `devspec/constitution.md` | Durable project principles across all work items and agents. |
+| `devspec/foundation/` | Product context, stack, structure, standards, rules, exclusions, and provider policy. |
+| `devspec/architecture/` | Architecture overview, diagrams, ADR templates, and artifact queue. |
+| `devspec/work-items/` | One folder per feature, bug, or security work item. |
+| `devspec/adapters/` | Multi-agent registry, compatibility, validation, and governance docs. |
+| `docs/how-to/` | User manual with install, workflow, AI coding agent, multi-repo, provider, validation, and upgrade examples. |
+| `.github/prompts/` | Copilot slash-command prompts. |
+| `.github/agents/` | Copilot agent definitions. |
+| `.github/skills/` | Optional reusable skills. |
+| `AGENTS.md` | Shared instructions for tools that read `AGENTS.md`. |
+| `GEMINI.md` | Gemini-native repository context. |
+| `.claude/`, `.cursor/`, `.gemini/`, `.agents/` | Optional adapter support. |
+
+## Manual Copy Fallback
+
+Use manual copy only when the CLI, `uvx`, package managers, and release ZIP automation are blocked. Copy these core files and folders from the `devspec` release into the target repository root:
+
+```text
+devspec/
+.github/prompts/
+.github/agents/
+AGENTS.md
+docs/how-to/
+```
+
+Then copy only the adapter files your team uses:
+
+| Tool | Additional files |
+| --- | --- |
+| GitHub Copilot | `.github/skills/` |
+| Claude Code | `.claude/` |
+| OpenAI Codex | No extra files beyond `AGENTS.md` |
+| Cursor | `.cursor/` |
+| Gemini CLI | `GEMINI.md`, `.gemini/` |
+| Google Antigravity | `.agents/` |
+
+Do not copy this framework repository's root `README.md` over a target project's README. Keep credentials, provider tokens, local auth files, and personal settings outside copied framework files.
+
+## Operating Rules
+
+- Keep `.github/prompts/*.prompt.md` and `.github/agents/*.agent.md` as the protected reference contracts.
+- Keep adapter support additive; do not change command intent for another tool.
+- Store workflow state in Git-tracked `devspec/` artifacts, not chat memory.
+- Use `devspec/glossary.md` for status values.
+- Use `devspec/foundation/codebase-structure.md` for repository access requirements.
+- Keep secrets and provider credentials outside prompt, agent, adapter, and artifact files.
+- Record blockers instead of guessing.
+- Recommend only registered `/devspec.*` commands.
+
+## Multi-Repo Work
+
+For multi-repo systems, open one workspace or tool project that includes every repository agents should inspect, edit, test, or coordinate.
+
+Record repository roles, local paths, access requirements, and boundaries in:
+
+```text
+devspec/foundation/codebase-structure.md
+```
+
+Access values are defined in:
+
+```text
+devspec/glossary.md#access-requirement-values
+```
+
+## Provider Integrations
+
+Use provider integrations when `/devspec.story` should resolve GitHub, Jira, Azure DevOps, or other external work-item references.
+
+Provider policy lives in:
+
+```text
+devspec/foundation/provider-integrations.md
+```
+
+Keep authentication outside prompt artifacts. Prefer read-only provider access unless write-back is explicitly required.
+
+## Validation
+
+Enterprise readiness requires these flows to pass for each supported adapter:
+
+- new repository foundation flow
+- existing repository extraction flow
+- full story lifecycle
+- cross-tool recovery from Git-tracked artifacts
+
+Use:
+
+```text
+devspec/adapters/validation-flows.md
+```
+
+## Upgrade Notes
+
+Use the CLI to inspect and apply framework upgrades:
+
+```text
+devspec diff --target .
+devspec sync --target . --profile all --dry-run
+devspec sync --target . --profile all
+```
+
+Framework-owned files may be replaced or diff-applied during upgrades:
+
+- `.github/prompts/`
+- `.github/agents/`
+- `.github/skills/`
+- adapter support folders
+- `AGENTS.md`
+- `GEMINI.md`
+- `devspec/adapters/`
+- `devspec/**/_template/`
+- `docs/how-to/`
+
+Project-owned files should be migrated or merged, not overwritten:
+
+- `devspec/foundation/*.md`
+- `devspec/architecture/*.md`
+- `devspec/architecture/diagrams/*.md`
+- `devspec/work-items/**`
+- `devspec/constitution.md`
+- `devspec/glossary.md`
+
+## Recommended Adoption
+
+1. Install into one target repository with `uvx devspec init --target . --profile all --repo-state existing`.
+2. Run the foundation flow.
+3. Complete one real feature work item.
+4. Complete one real bug work item.
+5. Add security-vulnerability flow validation if relevant.
+6. Adjust foundation docs based on what the first runs teach the team.
+
+## Deployment Development
+
+When changing the installer, profile manifest, package metadata, or release automation, run:
+
+```text
+uv run pytest
+powershell -ExecutionPolicy Bypass -File scripts/test-local-install.ps1
+bash scripts/test-local-install.sh
+```
+
+Update `packaging/devspec-profiles.json` whenever adapter files are added, removed, or moved.
+
+## License
+
+This repository is released under the [Apache License 2.0](LICENSE).