wry 0.5.1.dev4__tar.gz → 0.5.1.dev5__tar.gz

{wry-0.5.1.dev4 → wry-0.5.1.dev5}/.cursorrules

@@ -29,7 +29,12 @@ Before making any commit, AI assistants MUST:
    - Fix linter errors (ruff, mypy)
    - Format code properly (ruff format)
 
-5. **Follow Conventional Commits**:
+5. **Update TODO.md** (if applicable):
+   - Mark completed tasks as done
+   - Remove completed items or move to archive section
+   - Update progress on ongoing work
+
+6. **Follow Conventional Commits**:
    - Use format: `type: description`
    - Types: feat, fix, docs, refactor, test, chore, build
 

{wry-0.5.1.dev4 → wry-0.5.1.dev5}/CHANGELOG.md

@@ -32,6 +32,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - RELEASE_PROCESS.md: Documented that commits add to [Unreleased] during development
   - RELEASE_PROCESS.md: Explained that release commit converts [Unreleased] to [X.Y.Z]
 
+- **TODO.md integration** 📋
+  - .cursorrules: Added TODO.md update as step 5 in pre-commit requirements
+  - CONTRIBUTING.md: Added TODO.md checklist item (mark completed, update progress)
+  - RELEASE_PROCESS.md: Check TODO.md before release, update after release
+  - README.md: Added comprehensive "Documentation Index" section
+  - README.md: Listed TODO.md in "For Contributors" section
+  - README.md: Added "Quick Start Navigation" for users/contributors/AI assistants
+
 ### Tests
 
 - **Additional comma-separated test** (494 total tests)

{wry-0.5.1.dev4 → wry-0.5.1.dev5}/CONTRIBUTING.md

@@ -485,7 +485,15 @@ mypy wry/
 
 **Note**: Git commits automatically run pre-commit hooks (ruff, mypy, pytest). All must pass.
 
-### 5. wry-Specific Checks
+### 5. Update TODO.md (if applicable)
+
+- [ ] **TODO.md**: Update if working on tracked tasks
+  - Mark completed tasks as done (✅)
+  - Remove completed items or move to archive
+  - Update progress notes on ongoing work
+  - Add new tasks if discovered during development
+
+### 6. wry-Specific Checks
 
 - [ ] **Source tracking works**: If touching config/model code, verify source tracking
 - [ ] **Precedence correct**: CLI > JSON > ENV > DEFAULT (verify if changing)
@@ -648,5 +656,6 @@ For information about creating releases, see **`RELEASE_PROCESS.md`**.
 - Check `AI_KNOWLEDGE_BASE.md` for complete technical reference
 - Check `README.md` for user documentation
 - Check `RELEASE_PROCESS.md` for release workflow
+- Check `TODO.md` for current tasks and planned features
 - Check `tests/features/test_source_precedence.py` for source tracking examples
 - Open an issue for questions or clarifications

{wry-0.5.1.dev4/wry.egg-info → wry-0.5.1.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wry
-Version: 0.5.1.dev4
+Version: 0.5.1.dev5
 Summary: Why Repeat Yourself? - Define your CLI once with Pydantic models
 Author-email: Tyler House <26489166+tahouse@users.noreply.github.com>
 License: MIT
@@ -1066,6 +1066,50 @@ mypy wry
 - Start a discussion for general questions
 - Check existing issues/PRs before creating new ones
 
+## Documentation Index
+
+wry has comprehensive documentation for different audiences:
+
+### For Users
+- 📘 **`README.md`** (this file) - Getting started, features, usage examples
+- 📁 **`examples/`** - Working code examples
+  - `examples/autowrymodel_comprehensive.py` - Complete AutoWryModel features
+  - `examples/wrymodel_comprehensive.py` - WryModel with source tracking
+  - `examples/multimodel_comprehensive.py` - Multi-model usage
+
+### For Contributors
+- 📖 **`CONTRIBUTING.md`** - Complete contributor guide with code patterns and checklists
+- 🤖 **`.cursorrules`** - AI assistant quick reference (references CONTRIBUTING.md)
+- 🚀 **`RELEASE_PROCESS.md`** - How to create releases and manage versions
+- 📋 **`TODO.md`** - Current tasks, planned features, and work in progress
+
+### Technical Reference
+- 📚 **`AI_KNOWLEDGE_BASE.md`** - Complete technical reference for AI/LLMs (also useful for humans)
+- 📝 **`CHANGELOG.md`** - Version history and all changes
+- 🧪 **`tests/README.md`** - Test organization and structure
+- 🔧 **`scripts/README.md`** - Development scripts and tools
+
+### Quick Start Navigation
+
+**I'm a user, I want to...**
+- Get started → README.md "Quick Start" section
+- See examples → `examples/` directory
+- Understand features → README.md "Features" section
+- Track config sources → README.md "Value Source Tracking" section
+
+**I'm a contributor, I want to...**
+- Set up development → CONTRIBUTING.md "Development Setup" section
+- Add a feature → CONTRIBUTING.md "Adding New Features" section
+- Run tests → CONTRIBUTING.md "Testing" section
+- Create a release → RELEASE_PROCESS.md
+- Check current tasks → TODO.md
+
+**I'm an AI assistant, I want to...**
+- Quick reference → `.cursorrules`
+- Technical details → `AI_KNOWLEDGE_BASE.md`
+- Code patterns → `CONTRIBUTING.md`
+- Test examples → `tests/features/test_source_precedence.py`
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

{wry-0.5.1.dev4 → wry-0.5.1.dev5}/README.md

@@ -1022,6 +1022,50 @@ mypy wry
 - Start a discussion for general questions
 - Check existing issues/PRs before creating new ones
 
+## Documentation Index
+
+wry has comprehensive documentation for different audiences:
+
+### For Users
+- 📘 **`README.md`** (this file) - Getting started, features, usage examples
+- 📁 **`examples/`** - Working code examples
+  - `examples/autowrymodel_comprehensive.py` - Complete AutoWryModel features
+  - `examples/wrymodel_comprehensive.py` - WryModel with source tracking
+  - `examples/multimodel_comprehensive.py` - Multi-model usage
+
+### For Contributors
+- 📖 **`CONTRIBUTING.md`** - Complete contributor guide with code patterns and checklists
+- 🤖 **`.cursorrules`** - AI assistant quick reference (references CONTRIBUTING.md)
+- 🚀 **`RELEASE_PROCESS.md`** - How to create releases and manage versions
+- 📋 **`TODO.md`** - Current tasks, planned features, and work in progress
+
+### Technical Reference
+- 📚 **`AI_KNOWLEDGE_BASE.md`** - Complete technical reference for AI/LLMs (also useful for humans)
+- 📝 **`CHANGELOG.md`** - Version history and all changes
+- 🧪 **`tests/README.md`** - Test organization and structure
+- 🔧 **`scripts/README.md`** - Development scripts and tools
+
+### Quick Start Navigation
+
+**I'm a user, I want to...**
+- Get started → README.md "Quick Start" section
+- See examples → `examples/` directory
+- Understand features → README.md "Features" section
+- Track config sources → README.md "Value Source Tracking" section
+
+**I'm a contributor, I want to...**
+- Set up development → CONTRIBUTING.md "Development Setup" section
+- Add a feature → CONTRIBUTING.md "Adding New Features" section
+- Run tests → CONTRIBUTING.md "Testing" section
+- Create a release → RELEASE_PROCESS.md
+- Check current tasks → TODO.md
+
+**I'm an AI assistant, I want to...**
+- Quick reference → `.cursorrules`
+- Technical details → `AI_KNOWLEDGE_BASE.md`
+- Code patterns → `CONTRIBUTING.md`
+- Test examples → `tests/features/test_source_precedence.py`
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

{wry-0.5.1.dev4 → wry-0.5.1.dev5}/RELEASE_PROCESS.md

@@ -26,6 +26,7 @@ Follow these steps IN ORDER:
 
 1. **Verify all changes are in [Unreleased]**
    - Check that CHANGELOG.md `[Unreleased]` section has all changes since last release
+   - Check TODO.md - all planned release items should be completed
    - Ensure all tests pass (`pytest`)
    - Fix any linting issues
 
@@ -68,7 +69,13 @@ Follow these steps IN ORDER:
 
 ### After the Release
 
-Continue development by adding changes to the (now empty) `[Unreleased]` section.
+Continue development by:
+1. Adding new changes to the (now empty) `[Unreleased]` section in CHANGELOG.md
+2. Updating TODO.md:
+   - Archive or remove completed items from the released version
+   - Add new tasks or features planned for next release
+   - Update roadmap and priorities
+3. Update version numbers in AI_KNOWLEDGE_BASE.md if not already done
 
 ## Example
 

{wry-0.5.1.dev4 → wry-0.5.1.dev5}/wry/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.5.1.dev4'
-__version_tuple__ = version_tuple = (0, 5, 1, 'dev4')
+__version__ = version = '0.5.1.dev5'
+__version_tuple__ = version_tuple = (0, 5, 1, 'dev5')
 
-__commit_id__ = commit_id = 'g338dafeb9'
+__commit_id__ = commit_id = 'g1a3d554bc'

{wry-0.5.1.dev4 → wry-0.5.1.dev5/wry.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wry
-Version: 0.5.1.dev4
+Version: 0.5.1.dev5
 Summary: Why Repeat Yourself? - Define your CLI once with Pydantic models
 Author-email: Tyler House <26489166+tahouse@users.noreply.github.com>
 License: MIT
@@ -1066,6 +1066,50 @@ mypy wry
 - Start a discussion for general questions
 - Check existing issues/PRs before creating new ones
 
+## Documentation Index
+
+wry has comprehensive documentation for different audiences:
+
+### For Users
+- 📘 **`README.md`** (this file) - Getting started, features, usage examples
+- 📁 **`examples/`** - Working code examples
+  - `examples/autowrymodel_comprehensive.py` - Complete AutoWryModel features
+  - `examples/wrymodel_comprehensive.py` - WryModel with source tracking
+  - `examples/multimodel_comprehensive.py` - Multi-model usage
+
+### For Contributors
+- 📖 **`CONTRIBUTING.md`** - Complete contributor guide with code patterns and checklists
+- 🤖 **`.cursorrules`** - AI assistant quick reference (references CONTRIBUTING.md)
+- 🚀 **`RELEASE_PROCESS.md`** - How to create releases and manage versions
+- 📋 **`TODO.md`** - Current tasks, planned features, and work in progress
+
+### Technical Reference
+- 📚 **`AI_KNOWLEDGE_BASE.md`** - Complete technical reference for AI/LLMs (also useful for humans)
+- 📝 **`CHANGELOG.md`** - Version history and all changes
+- 🧪 **`tests/README.md`** - Test organization and structure
+- 🔧 **`scripts/README.md`** - Development scripts and tools
+
+### Quick Start Navigation
+
+**I'm a user, I want to...**
+- Get started → README.md "Quick Start" section
+- See examples → `examples/` directory
+- Understand features → README.md "Features" section
+- Track config sources → README.md "Value Source Tracking" section
+
+**I'm a contributor, I want to...**
+- Set up development → CONTRIBUTING.md "Development Setup" section
+- Add a feature → CONTRIBUTING.md "Adding New Features" section
+- Run tests → CONTRIBUTING.md "Testing" section
+- Create a release → RELEASE_PROCESS.md
+- Check current tasks → TODO.md
+
+**I'm an AI assistant, I want to...**
+- Quick reference → `.cursorrules`
+- Technical details → `AI_KNOWLEDGE_BASE.md`
+- Code patterns → `CONTRIBUTING.md`
+- Test examples → `tests/features/test_source_precedence.py`
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.