Skip to content

PENDING_TASKS.md

Latest commit

 

History

History
207 lines (164 loc) · 5.29 KB

PENDING_TASKS.md

File metadata and controls

207 lines (164 loc) · 5.29 KB

Pending Tasks and Recommendations

✅ Completed (Recent Work)

Testing & Quality

  • ✅ Comprehensive integration tests (30 new tests, 146 total passing)
  • ✅ Test coverage improved to 83.10% (above 55% threshold)
  • ✅ All test failures fixed
  • ✅ Pre-commit hooks configured with ruff
  • ✅ Test coverage reporting with pytest-cov

Documentation

  • ✅ Comprehensive usage guide (USAGE.md)
  • ✅ Example code (examples/simple_example.py)
  • ✅ Development guide (DEVELOPMENT.md)
  • ✅ Changelog created (CHANGELOG.md)
  • ✅ AI instructions for changelog maintenance (.cursorrules)

Code Quality

  • ✅ Replaced black/isort/flake8 with ruff
  • ✅ Fixed GraphViz TABLE support bug
  • ✅ Fixed empty list handling in dot()
  • ✅ Module import functionality implemented
  • ✅ cmd_refresh filtering for existing matviews

Project Metadata

  • ✅ Project description added to pyproject.toml
  • ✅ Project URLs added to pyproject.toml
  • ✅ Keywords and classifiers added
  • ✅ License file reference added

🎯 High Priority - Still Pending

1. CI/CD Pipeline (Critical)

Status: Not started Priority: High Effort: Medium

What's needed:

  • GitHub Actions workflow (.github/workflows/test.yml)
  • Test on Python 3.12, 3.13, 3.14
  • Run unit and integration tests
  • PostgreSQL service for integration tests
  • Coverage reporting
  • Linting checks (ruff, mypy)
  • Run on all PRs

Benefits:

  • Automated testing prevents regressions
  • Ensures code quality on all PRs
  • Multiple Python version compatibility

2. CONTRIBUTING.md

Status: Not started Priority: High Effort: Low

What's needed:

  • Contributing guidelines
  • Development setup
  • Testing guidelines
  • Code style guide
  • PR process
  • Code of conduct (optional)

Note: We have DEVELOPMENT.md but CONTRIBUTING.md is more user-focused

3. Update Outdated Documentation

Status: Needs update Priority: Medium Effort: Low

Files to update:

  • TEST_STATUS.md - Still says 86 tests, we now have 146 passing
  • TEST_FIXES.md - All fixes are complete, can be archived
  • CHANGES.md - Can be consolidated into CHANGELOG.md

📋 Medium Priority - Recommended

4. Module Discovery Patterns

Status: Not started Priority: Medium Effort: High

What's needed:

  • Support patterns like myapp.*.views
  • Support **/dbsamizdat_defs.py glob patterns
  • Better module discovery UX

5. Better Error Messages

Status: Partial Priority: Medium Effort: Medium

What's needed:

  • More context in ImportError messages
  • Suggest fixes in error messages
  • Add troubleshooting hints
  • Validate module names before import

6. Library API Enhancements

Status: Not started Priority: Medium Effort: Medium

What's needed:

  • Expose dry-run mode in library API (txstyle.DRYRUN)
  • Add progress callbacks to sync/refresh functions
  • Better programmatic control

7. Input Validation

Status: Partial Priority: Medium Effort: Low

What's needed:

  • Validate database connection strings
  • Validate module names format
  • Basic SQL template sanity checks

🚀 Feature Enhancements - Future

8. Async Support

Status: Not started Priority: Low Effort: High

What's needed:

  • Async database connections
  • Async versions of sync/refresh/nuke functions
  • Support for async frameworks (FastAPI, etc.)

9. Advanced Testing

Status: Not started Priority: Low Effort: Medium

What's needed:

  • Property-based tests (Hypothesis)
  • Performance/benchmark tests
  • SQL template fuzzing

10. Developer Experience

Status: Not started Priority: Low Effort: Medium

What's needed:

  • VS Code Dev Container configuration
  • Makefile for common tasks
  • Better error recovery utilities

11. Observability

Status: Not started Priority: Low Effort: High

What's needed:

  • Structured logging (JSON format option)
  • Metrics/telemetry collection
  • Correlation IDs for tracking

12. Security Documentation

Status: Not started Priority: Medium Effort: Low

What's needed:

  • SQL injection prevention documentation
  • Safe vs unsafe pattern examples
  • Security considerations guide

📝 Documentation Cleanup

13. Consolidate Documentation

Status: Needs work Priority: Low Effort: Low

What's needed:

  • Archive or consolidate TEST_FIXES.md (all fixes complete)
  • Update TEST_STATUS.md (outdated test counts)
  • Consider consolidating CHANGES.md into CHANGELOG.md
  • Update RECOMMENDATIONS.md to mark completed items

🎯 Immediate Next Steps (This Week)

  1. Set up CI/CD pipeline - Critical for preventing regressions
  2. Create CONTRIBUTING.md - Help new contributors
  3. Update outdated docs - Keep documentation current
  4. Add input validation - Improve error handling

📊 Success Metrics

Track progress on:

  • ✅ Test Coverage: 83.10% (target: 80%+) - ACHIEVED
  • ⏳ CI/CD: Automated testing on PRs - PENDING
  • ⏳ Documentation: Complete API reference - PARTIAL
  • ⏳ Developer Experience: Time to first contribution - IMPROVING

💡 Quick Wins (< 1 hour each)

  1. Update TEST_STATUS.md with current test counts
  2. Archive TEST_FIXES.md (all fixes complete)
  3. Create CONTRIBUTING.md from DEVELOPMENT.md template
  4. Add input validation for module names
  5. Improve error messages with context