|
| 1 | +# Development Roadmap - Nutrient DWS Python Client |
| 2 | + |
| 3 | +## 📊 Issue Review & Recommendations |
| 4 | + |
| 5 | +After reviewing all open issues and analyzing the codebase, here are my recommendations for what to tackle next: |
| 6 | + |
| 7 | +### 🥇 **Top Priority: Quick Wins (1-2 days each)** |
| 8 | + |
| 9 | +#### 1. **Issue #11: Image Watermark Support** ⭐⭐⭐⭐⭐ |
| 10 | +- **Why**: 80% already implemented! Just needs file upload support |
| 11 | +- **Current**: Supports `image_url` parameter |
| 12 | +- **Add**: `image_file` parameter for local image files |
| 13 | +- **Effort**: Very Low - mostly parameter handling |
| 14 | +- **Value**: High - common user request |
| 15 | + |
| 16 | +#### 2. **Issue #10: Multi-Language OCR Support** ⭐⭐⭐⭐ |
| 17 | +- **Why**: Small change with big impact |
| 18 | +- **Current**: Single language string |
| 19 | +- **Add**: Accept `List[str]` for multiple languages |
| 20 | +- **Effort**: Low - update parameter handling and validation |
| 21 | +- **Value**: High - enables multi-lingual document processing |
| 22 | + |
| 23 | +### 🥈 **Second Priority: Core Features (3-5 days each)** |
| 24 | + |
| 25 | +#### 3. **Issue #13: Create Redactions Method** ⭐⭐⭐⭐ |
| 26 | +- **Why**: Complements existing `apply_redactions()` |
| 27 | +- **Value**: Complete redaction workflow |
| 28 | +- **Complexity**: Medium - new API patterns for search strategies |
| 29 | +- **Use cases**: Compliance, privacy, legal docs |
| 30 | + |
| 31 | +#### 4. **Issue #12: Selective Annotation Flattening** ⭐⭐⭐ |
| 32 | +- **Why**: Enhancement to existing `flatten_annotations()` |
| 33 | +- **Add**: `annotation_ids` parameter |
| 34 | +- **Effort**: Low-Medium |
| 35 | +- **Value**: More control over flattening |
| 36 | + |
| 37 | +### 🥉 **Third Priority: High-Value Features (1 week each)** |
| 38 | + |
| 39 | +#### 5. **Issue #16: Convert to PDF/A** ⭐⭐⭐⭐ |
| 40 | +- **Why**: Critical for archival/compliance |
| 41 | +- **Value**: Legal requirement for many organizations |
| 42 | +- **Complexity**: Medium - new output format handling |
| 43 | + |
| 44 | +#### 6. **Issue #17: Convert PDF to Images** ⭐⭐⭐⭐ |
| 45 | +- **Why**: Very common use case |
| 46 | +- **Value**: Thumbnails, previews, web display |
| 47 | +- **Complexity**: Medium - handle multiple output files |
| 48 | + |
| 49 | +### 📋 **Issues to Defer** |
| 50 | + |
| 51 | +- **Issue #20: AI-Powered Redaction** - Requires AI endpoint investigation |
| 52 | +- **Issue #21: Digital Signatures** - Complex, needs certificate handling |
| 53 | +- **Issue #22: Batch Processing** - Client-side enhancement, do after core features |
| 54 | +- **Issue #19: Office Formats** - Lower priority, complex format handling |
| 55 | + |
| 56 | +### 🎯 **Recommended Implementation Order** |
| 57 | + |
| 58 | +**Sprint 1 (Week 1):** |
| 59 | +1. Image Watermark Support (1 day) |
| 60 | +2. Multi-Language OCR (1 day) |
| 61 | +3. Selective Annotation Flattening (2 days) |
| 62 | + |
| 63 | +**Sprint 2 (Week 2):** |
| 64 | +4. Create Redactions Method (4 days) |
| 65 | + |
| 66 | +**Sprint 3 (Week 3):** |
| 67 | +5. Convert to PDF/A (3 days) |
| 68 | +6. Convert PDF to Images (3 days) |
| 69 | + |
| 70 | +### 💡 **Why This Order?** |
| 71 | + |
| 72 | +1. **Quick Wins First**: Build momentum with easy enhancements |
| 73 | +2. **Complete Workflows**: Redaction creation completes the redaction workflow |
| 74 | +3. **High User Value**: PDF/A and image conversion are frequently requested |
| 75 | +4. **Incremental Complexity**: Start simple, build up to more complex features |
| 76 | +5. **API Coverage**: These 6 features would increase API coverage significantly |
| 77 | + |
| 78 | +### 📈 **Expected Outcomes** |
| 79 | + |
| 80 | +After implementing these 6 features: |
| 81 | +- **Methods**: 18 total (up from 12) |
| 82 | +- **API Coverage**: ~50% (up from ~30%) |
| 83 | +- **User Satisfaction**: Address most common feature requests |
| 84 | +- **Time**: ~3 weeks of development |
| 85 | + |
| 86 | +## 🚀 Current Status |
| 87 | + |
| 88 | +As of the last update: |
| 89 | +- **PR #7 (Direct API Methods)**: ✅ Merged - Added 5 new methods |
| 90 | +- **PR #23 (OpenAPI Compliance)**: ✅ Merged - Added comprehensive documentation |
| 91 | +- **Current Methods**: 12 Direct API methods |
| 92 | +- **Test Coverage**: 94% |
| 93 | +- **Python Support**: 3.8 - 3.12 |
| 94 | + |
| 95 | +## 📝 Notes |
| 96 | + |
| 97 | +- All features should maintain backward compatibility |
| 98 | +- Each feature should include comprehensive tests |
| 99 | +- Documentation should reference OpenAPI spec where applicable |
| 100 | +- Integration tests should be added for each new method |
0 commit comments