doit-toolkit-cli 0.1.10__py3-none-any.whl

doit_cli/templates/tasks-template.md

@@ -0,0 +1,313 @@
+---
+
+description: "Task list template for feature implementation"
+---
+
+# Tasks: [FEATURE NAME]
+
+**Input**: Design documents from `/specs/[###-feature-name]/`
+**Prerequisites**: plan.md (required), spec.md (required for user stories), research.md, data-model.md, contracts/
+
+**Tests**: The examples below include test tasks. Tests are OPTIONAL - only include them if explicitly requested in the feature specification.
+
+**Organization**: Tasks are grouped by user story to enable independent implementation and testing of each story.
+
+## Task Dependencies
+
+<!--
+  AUTO-GENERATED: This section is populated by /doit.taskit based on task relationships.
+  The flowchart shows task execution order and parallel opportunities.
+  Regenerate by running /doit.taskit again.
+-->
+
+<!-- BEGIN:AUTO-GENERATED section="task-dependencies" -->
+```mermaid
+flowchart TD
+    subgraph "Phase 1: Setup"
+        T001[T001: Setup]
+    end
+
+    subgraph "Phase 2: Foundation"
+        T002[T002: Dependencies]
+        T003[T003: Core]
+    end
+
+    subgraph "Phase 3: Implementation"
+        T004[T004: Feature A]
+        T005[T005: Feature B]
+        T006[T006: Integration]
+    end
+
+    T001 --> T002 --> T003
+    T003 --> T004 & T005
+    T004 & T005 --> T006
+```
+<!-- END:AUTO-GENERATED -->
+
+## Phase Timeline
+
+<!--
+  AUTO-GENERATED: This section is populated by /doit.taskit based on phase structure.
+  The gantt chart shows estimated phase durations and dependencies.
+  Regenerate by running /doit.taskit again.
+-->
+
+<!-- BEGIN:AUTO-GENERATED section="phase-timeline" -->
+```mermaid
+gantt
+    title Implementation Phases
+    dateFormat YYYY-MM-DD
+
+    section Phase 1: Setup
+    Project initialization    :a1, 2024-01-01, 1d
+
+    section Phase 2: Foundation
+    Core infrastructure       :b1, after a1, 2d
+
+    section Phase 3: User Stories
+    User Story 1 (P1)         :c1, after b1, 2d
+    User Story 2 (P2)         :c2, after c1, 2d
+    User Story 3 (P3)         :c3, after c2, 2d
+
+    section Phase N: Polish
+    Final polish              :d1, after c3, 1d
+```
+<!-- END:AUTO-GENERATED -->
+
+## Format: `[ID] [P?] [Story] Description`
+
+- **[P]**: Can run in parallel (different files, no dependencies)
+- **[Story]**: Which user story this task belongs to (e.g., US1, US2, US3)
+- Include exact file paths in descriptions
+
+## Path Conventions
+
+- **Single project**: `src/`, `tests/` at repository root
+- **Web app**: `backend/src/`, `frontend/src/`
+- **Mobile**: `api/src/`, `ios/src/` or `android/src/`
+- Paths shown below assume single project - adjust based on plan.md structure
+
+<!-- 
+  ============================================================================
+  IMPORTANT: The tasks below are SAMPLE TASKS for illustration purposes only.
+  
+  The /doit.taskit command MUST replace these with actual tasks based on:
+  - User stories from spec.md (with their priorities P1, P2, P3...)
+  - Feature requirements from plan.md
+  - Entities from data-model.md
+  - Endpoints from contracts/
+  
+  Tasks MUST be organized by user story so each story can be:
+  - Implemented independently
+  - Tested independently
+  - Delivered as an MVP increment
+  
+  DO NOT keep these sample tasks in the generated tasks.md file.
+  ============================================================================
+-->
+
+## Phase 1: Setup (Shared Infrastructure)
+
+**Purpose**: Project initialization and basic structure
+
+- [ ] T001 Create project structure per implementation plan
+- [ ] T002 Initialize [language] project with [framework] dependencies
+- [ ] T003 [P] Configure linting and formatting tools
+
+---
+
+## Phase 2: Foundational (Blocking Prerequisites)
+
+**Purpose**: Core infrastructure that MUST be complete before ANY user story can be implemented
+
+**⚠️ CRITICAL**: No user story work can begin until this phase is complete
+
+Examples of foundational tasks (adjust based on your project):
+
+- [ ] T004 Setup database schema and migrations framework
+- [ ] T005 [P] Implement authentication/authorization framework
+- [ ] T006 [P] Setup API routing and middleware structure
+- [ ] T007 Create base models/entities that all stories depend on
+- [ ] T008 Configure error handling and logging infrastructure
+- [ ] T009 Setup environment configuration management
+
+**Checkpoint**: Foundation ready - user story implementation can now begin in parallel
+
+---
+
+## Phase 3: User Story 1 - [Title] (Priority: P1) 🎯 MVP
+
+**Goal**: [Brief description of what this story delivers]
+
+**Independent Test**: [How to verify this story works on its own]
+
+### Tests for User Story 1 (OPTIONAL - only if tests requested) ⚠️
+
+> **NOTE: Write these tests FIRST, ensure they FAIL before implementation**
+
+- [ ] T010 [P] [US1] Contract test for [endpoint] in tests/contract/test_[name].py
+- [ ] T011 [P] [US1] Integration test for [user journey] in tests/integration/test_[name].py
+
+### Implementation for User Story 1
+
+- [ ] T012 [P] [US1] Create [Entity1] model in src/models/[entity1].py
+- [ ] T013 [P] [US1] Create [Entity2] model in src/models/[entity2].py
+- [ ] T014 [US1] Implement [Service] in src/services/[service].py (depends on T012, T013)
+- [ ] T015 [US1] Implement [endpoint/feature] in src/[location]/[file].py
+- [ ] T016 [US1] Add validation and error handling
+- [ ] T017 [US1] Add logging for user story 1 operations
+
+**Checkpoint**: At this point, User Story 1 should be fully functional and testable independently
+
+---
+
+## Phase 4: User Story 2 - [Title] (Priority: P2)
+
+**Goal**: [Brief description of what this story delivers]
+
+**Independent Test**: [How to verify this story works on its own]
+
+### Tests for User Story 2 (OPTIONAL - only if tests requested) ⚠️
+
+- [ ] T018 [P] [US2] Contract test for [endpoint] in tests/contract/test_[name].py
+- [ ] T019 [P] [US2] Integration test for [user journey] in tests/integration/test_[name].py
+
+### Implementation for User Story 2
+
+- [ ] T020 [P] [US2] Create [Entity] model in src/models/[entity].py
+- [ ] T021 [US2] Implement [Service] in src/services/[service].py
+- [ ] T022 [US2] Implement [endpoint/feature] in src/[location]/[file].py
+- [ ] T023 [US2] Integrate with User Story 1 components (if needed)
+
+**Checkpoint**: At this point, User Stories 1 AND 2 should both work independently
+
+---
+
+## Phase 5: User Story 3 - [Title] (Priority: P3)
+
+**Goal**: [Brief description of what this story delivers]
+
+**Independent Test**: [How to verify this story works on its own]
+
+### Tests for User Story 3 (OPTIONAL - only if tests requested) ⚠️
+
+- [ ] T024 [P] [US3] Contract test for [endpoint] in tests/contract/test_[name].py
+- [ ] T025 [P] [US3] Integration test for [user journey] in tests/integration/test_[name].py
+
+### Implementation for User Story 3
+
+- [ ] T026 [P] [US3] Create [Entity] model in src/models/[entity].py
+- [ ] T027 [US3] Implement [Service] in src/services/[service].py
+- [ ] T028 [US3] Implement [endpoint/feature] in src/[location]/[file].py
+
+**Checkpoint**: All user stories should now be independently functional
+
+---
+
+[Add more user story phases as needed, following the same pattern]
+
+---
+
+## Phase N: Polish & Cross-Cutting Concerns
+
+**Purpose**: Improvements that affect multiple user stories
+
+- [ ] TXXX [P] Documentation updates in docs/
+- [ ] TXXX Code cleanup and refactoring
+- [ ] TXXX Performance optimization across all stories
+- [ ] TXXX [P] Additional unit tests (if requested) in tests/unit/
+- [ ] TXXX Security hardening
+- [ ] TXXX Run quickstart.md validation
+
+---
+
+## Dependencies & Execution Order
+
+### Phase Dependencies
+
+- **Setup (Phase 1)**: No dependencies - can start immediately
+- **Foundational (Phase 2)**: Depends on Setup completion - BLOCKS all user stories
+- **User Stories (Phase 3+)**: All depend on Foundational phase completion
+  - User stories can then proceed in parallel (if staffed)
+  - Or sequentially in priority order (P1 → P2 → P3)
+- **Polish (Final Phase)**: Depends on all desired user stories being complete
+
+### User Story Dependencies
+
+- **User Story 1 (P1)**: Can start after Foundational (Phase 2) - No dependencies on other stories
+- **User Story 2 (P2)**: Can start after Foundational (Phase 2) - May integrate with US1 but should be independently testable
+- **User Story 3 (P3)**: Can start after Foundational (Phase 2) - May integrate with US1/US2 but should be independently testable
+
+### Within Each User Story
+
+- Tests (if included) MUST be written and FAIL before implementation
+- Models before services
+- Services before endpoints
+- Core implementation before integration
+- Story complete before moving to next priority
+
+### Parallel Opportunities
+
+- All Setup tasks marked [P] can run in parallel
+- All Foundational tasks marked [P] can run in parallel (within Phase 2)
+- Once Foundational phase completes, all user stories can start in parallel (if team capacity allows)
+- All tests for a user story marked [P] can run in parallel
+- Models within a story marked [P] can run in parallel
+- Different user stories can be worked on in parallel by different team members
+
+---
+
+## Parallel Example: User Story 1
+
+```bash
+# Launch all tests for User Story 1 together (if tests requested):
+Task: "Contract test for [endpoint] in tests/contract/test_[name].py"
+Task: "Integration test for [user journey] in tests/integration/test_[name].py"
+
+# Launch all models for User Story 1 together:
+Task: "Create [Entity1] model in src/models/[entity1].py"
+Task: "Create [Entity2] model in src/models/[entity2].py"
+```
+
+---
+
+## Implementation Strategy
+
+### MVP First (User Story 1 Only)
+
+1. Complete Phase 1: Setup
+2. Complete Phase 2: Foundational (CRITICAL - blocks all stories)
+3. Complete Phase 3: User Story 1
+4. **STOP and VALIDATE**: Test User Story 1 independently
+5. Deploy/demo if ready
+
+### Incremental Delivery
+
+1. Complete Setup + Foundational → Foundation ready
+2. Add User Story 1 → Test independently → Deploy/Demo (MVP!)
+3. Add User Story 2 → Test independently → Deploy/Demo
+4. Add User Story 3 → Test independently → Deploy/Demo
+5. Each story adds value without breaking previous stories
+
+### Parallel Team Strategy
+
+With multiple developers:
+
+1. Team completes Setup + Foundational together
+2. Once Foundational is done:
+   - Developer A: User Story 1
+   - Developer B: User Story 2
+   - Developer C: User Story 3
+3. Stories complete and integrate independently
+
+---
+
+## Notes
+
+- [P] tasks = different files, no dependencies
+- [Story] label maps task to specific user story for traceability
+- Each user story should be independently completable and testable
+- Verify tests fail before implementing
+- Commit after each task or logical group
+- Stop at any checkpoint to validate story independently
+- Avoid: vague tasks, same file conflicts, cross-story dependencies that break independence

doit_cli/templates/vscode-settings.json

@@ -0,0 +1,14 @@
+{
+    "chat.promptFilesRecommendations": {
+        "speckit.constitution": true,
+        "speckit.doit": true,
+        "speckit.plan": true,
+        "speckit.tasks": true,
+        "speckit.implement": true
+    },
+    "chat.tools.terminal.autoApprove": {
+        ".doit/scripts/bash/": true,
+        ".doit/scripts/powershell/": true
+    }
+}
+

doit_toolkit_cli-0.1.10.dist-info/METADATA

@@ -0,0 +1,324 @@
+Metadata-Version: 2.4
+Name: doit-toolkit-cli
+Version: 0.1.10
+Summary: Doit CLI - A tool to bootstrap your projects for Spec-Driven Development (SDD).
+Project-URL: Homepage, https://github.com/seanbarlow/doit
+Project-URL: Documentation, https://github.com/seanbarlow/doit#readme
+Project-URL: Repository, https://github.com/seanbarlow/doit.git
+Project-URL: Issues, https://github.com/seanbarlow/doit/issues
+Author-email: Sean Barlow <sbarlow@barlowtech.com>
+License: MIT
+License-File: LICENSE
+Keywords: ai,cli,development-workflow,scaffolding,sdd,spec-driven-development
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Requires-Dist: httpx[socks]
+Requires-Dist: platformdirs
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: readchar
+Requires-Dist: rich>=13.0.0
+Requires-Dist: truststore>=0.10.4
+Requires-Dist: typer>=0.9.0
+Provides-Extra: advanced
+Requires-Dist: scikit-learn>=1.3.0; extra == 'advanced'
+Requires-Dist: tiktoken>=0.5.0; extra == 'advanced'
+Provides-Extra: dev
+Requires-Dist: pytest-tmp-files>=0.0.2; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="media/doit-logo-white.svg">
+    <img src="media/doit-logo-full-color.svg" alt="Do-It Framework Logo" width="200">
+  </picture>
+</div>
+
+# Do-It - Spec-Driven Development Framework
+
+<div align="center">
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![GitHub Stars](https://img.shields.io/github/stars/seanbarlow/doit?style=social)](https://github.com/seanbarlow/doit)
+[![PyPI version](https://img.shields.io/pypi/v/doit-toolkit-cli.svg)](https://pypi.org/project/doit-toolkit-cli/)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+
+**See your architecture before you build it.** Do-It is an opinionated, AI-powered framework for specification-driven development. Define specifications, auto-generate diagrams, create roadmaps, and build with confidence.
+
+[Quick Start](#quick-start) | [Documentation](https://github.com/seanbarlow/doit/tree/main/docs) | [Contributing](#contributing)
+
+</div>
+
+---
+
+## Features
+
+- **Specification-Driven** - Define what you're building before you build it
+- **Auto-Generated Diagrams** - Automatic Mermaid diagrams from specs (user journeys, architecture, ER models, task dependencies, timelines)
+- **Intelligent Roadmapping** - Prioritized roadmaps with P1-P4 system and vision tracking
+- **Guided Workflows** - Step-by-step interactive initialization with progress tracking, back navigation, and state recovery
+- **Persistent Memory** - All project context stored in version-controlled `.doit/memory/` folder
+- **Opinionated Approach** - Best practices built-in; strong opinions that reduce decision fatigue
+- **AI-Powered** - Works with Claude Code, Cursor, and other AI coding assistants via slash commands
+- **Team-Focused** - Quality gates, code reviews, and collaborative workflows built-in
+- **Living Docs** - Automatically organized and indexed project documentation
+
+## The Problem Do-It Solves
+
+Most projects fail not from technical debt, but from **architectural debt** - decisions made early without full context. Teams struggle with:
+
+- Architecture decisions made in isolation
+- Specifications that don't stay in sync with code
+- Scattered documentation that's always out of date
+- Roadmaps that don't reflect actual priorities
+- Teams working from different understandings of the same system
+- Manual diagram creation that becomes a chore
+
+**Do-It solves this by making specification and decision-making the foundation of development.**
+
+## Quick Start
+
+### Installation
+
+```bash
+# Using uv (recommended)
+uv tool install doit-toolkit-cli
+
+# Or using pipx
+pipx install doit-toolkit-cli
+
+# Or using pip
+pip install doit-toolkit-cli
+```
+
+### Initialize Your Project
+
+```bash
+# Create a new project
+doit init my-project
+
+# Or initialize in current directory
+doit init .
+```
+
+This creates the `.doit/` folder structure with:
+
+- `memory/` - Project context files (constitution, tech-stack, etc.)
+- `templates/` - Spec, plan, and task templates
+- `scripts/` - Automation scripts (bash and PowerShell)
+
+### The Do-It Workflow (AI Agent Slash Commands)
+
+Do-It provides slash commands for AI coding assistants like Claude Code:
+
+```markdown
+# 1. Define your project principles
+/doit.constitution This project follows a "Security-First" approach...
+
+# 2. Write your specification
+/doit.specit Build a collaborative task management app with real-time updates
+# -> Auto-generates: user journey diagram, entity relationships
+
+# 3. Create your technical plan
+/doit.planit Use React frontend, Node.js backend, PostgreSQL database
+# -> Auto-generates: architecture diagram, component dependencies
+
+# 4. Break down into tasks
+/doit.taskit
+# -> Auto-generates: task dependencies, phase timeline
+
+# 5. Implement with AI assistance
+/doit.implementit
+
+# 6. Run quality assurance
+/doit.testit
+
+# 7. Team review
+/doit.reviewit
+
+# 8. Check in and archive
+/doit.checkin
+```
+
+## Commands
+
+### Slash Commands (AI Agent)
+
+Run these in your AI coding assistant (Claude Code, Copilot, etc.):
+
+| Command | Purpose | Output |
+|---------|---------|--------|
+| **/doit.constitution** | Document project principles | constitution.md |
+| **/doit.specit** | Define user stories and features | User journey diagrams, spec.md |
+| **/doit.planit** | Create technical architecture | Architecture diagram, plan.md |
+| **/doit.taskit** | Break down into tasks | Task dependencies, timeline, tasks.md |
+| **/doit.implementit** | Implement features | Executes task queue with AI |
+| **/doit.testit** | Quality assurance | Test results, coverage reports |
+| **/doit.reviewit** | Team code review | Review findings, review-report.md |
+| **/doit.roadmapit** | Manage priorities | roadmap.md with P1-P4 items |
+| **/doit.documentit** | Organize documentation | Organized docs/, index.md |
+| **/doit.scaffoldit** | Bootstrap new projects | .doit/ structure, templates |
+| **/doit.fixit** | Bug-fix workflow | Investigation, fix planning, review |
+| **/doit.checkin** | Archive completed work | PR creation, issue closing |
+
+### CLI Commands (Terminal)
+
+Run these in your terminal:
+
+| Command | Purpose |
+|---------|---------|
+| `doit init` | Initialize Do-It in a project |
+| `doit verify` | Verify project structure |
+| `doit sync-prompts` | Sync templates to AI agents |
+| `doit context show` | Display loaded project context |
+| `doit hooks install` | Install git hooks for workflow enforcement |
+| `doit hooks validate` | Validate branch meets requirements |
+| `doit validate` | Validate spec against quality rules |
+| `doit status` | Show spec status dashboard |
+| `doit xref` | Cross-reference specs and tasks |
+| `doit diagram` | Generate Mermaid diagrams from specs |
+
+## Project Structure
+
+```
+your-project/
+├── README.md                    # Your project README
+├── .doit/                       # Do-It configuration (version control!)
+│   ├── memory/
+│   │   ├── constitution.md      # Project principles
+│   │   ├── tech-stack.md        # Technology choices
+│   │   ├── roadmap.md           # Feature priorities (P1-P4)
+│   │   └── completed_roadmap.md # Archive of shipped features
+│   ├── templates/
+│   │   ├── spec-template.md
+│   │   ├── plan-template.md
+│   │   └── task-template.md
+│   └── scripts/
+│       ├── bash/                # Bash automation scripts
+│       └── powershell/          # PowerShell automation scripts
+├── specs/                       # Feature specifications
+│   └── NNN-feature-name/
+│       ├── spec.md              # Feature specification
+│       ├── plan.md              # Technical plan
+│       ├── tasks.md             # Task breakdown
+│       └── research.md          # Research notes
+├── docs/                        # Project documentation
+└── src/                         # Your application code
+```
+
+## Auto-Generated Diagrams
+
+Do-It automatically generates these diagram types from your specifications:
+
+- **User Journey** - How users interact with your system
+- **Architecture** - System components and boundaries
+- **Component Dependencies** - Service relationships
+- **Entity Relationships** - Database schema
+- **Sequence Diagrams** - Time-based interactions
+- **Task Dependencies** - Execution order and critical path
+- **Phase Timeline** - Gantt chart of development phases
+- **Finding Distribution** - Code review findings breakdown
+
+All diagrams are in Mermaid format, work in markdown, and update automatically when specs change.
+
+## Persistent Memory System
+
+Your entire project context lives in version-controlled markdown files:
+
+```
+.doit/memory/
+├── constitution.md        # "Why do we exist? What are our principles?"
+├── tech-stack.md          # "What technologies are we using?"
+├── roadmap.md             # "What's the priority order?"
+└── completed_roadmap.md   # "What have we shipped?" (20-item archive)
+```
+
+Because these files are in git:
+
+- Your entire team sees the same context
+- History is preserved (git blame, logs)
+- Decisions are documented with rationale
+- New team members have full context
+- No external dependencies or databases
+
+## Documentation
+
+- [Installation Guide](docs/installation.md) - Getting started with Do-It
+- [Quick Start Guide](docs/quickstart.md) - 5-minute tutorial
+- [Template System](docs/templates/index.md) - Understanding templates
+- [Command Reference](docs/templates/commands.md) - All slash commands explained
+- [Workflow System Guide](docs/guides/workflow-system-guide.md) - Interactive workflow architecture
+- [Creating Workflows Tutorial](docs/tutorials/creating-workflows.md) - Build custom workflows
+
+## Contributing
+
+We welcome contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
+
+**Quick start for contributors:**
+
+```bash
+# Clone the repo
+git clone https://github.com/seanbarlow/doit.git
+cd doit
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install in development mode
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+```
+
+## License
+
+Do-It is licensed under the MIT License. See [LICENSE](./LICENSE) for details.
+
+## Reporting Issues
+
+Found a bug? Have a feature request?
+
+- **[GitHub Issues](https://github.com/seanbarlow/doit/issues)** - Bug reports and feature requests
+- **[Discussions](https://github.com/seanbarlow/doit/discussions)** - Questions and ideas
+
+Please include:
+- Do-It version (`doit --version`)
+- Python version (`python --version`)
+- Operating system
+- Steps to reproduce (for bugs)
+- Expected vs. actual behavior
+
+## Status
+
+- **Current Version:** 0.1.8
+- **Python Support:** 3.11, 3.12
+- **Status:** Beta
+- **Last Updated:** January 2026
+
+See [CHANGELOG.md](./CHANGELOG.md) for release notes.
+
+## Acknowledgments
+
+- Diagram generation powered by [Mermaid](https://mermaid.js.org/)
+- CLI built with [Typer](https://typer.tiangolo.com/) and [Rich](https://rich.readthedocs.io/)
+
+---
+
+<div align="center">
+
+Made with care by the Do-It community
+
+[Star us on GitHub](https://github.com/seanbarlow/doit)
+
+</div>