Update documentation for hybrid config and Gmail API vs SMTP delivery
- README.md: document hybrid config model, Gmail API vs SMTP comparison, update architecture diagram, replace Postmarkapp with Apprise - ARCHITECTURE.md: add Gmail API vs SMTP comparison table, document ConfigService and AppSetting, add settings/gmail API endpoints - CHANGELOG.md: add entries for database-backed config and documentation - TODO.md: update progress (59% coverage, production readiness 30%) - .env.example: document bootstrap vs database-managed settings Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com> Agent-Logs-Url: https://github.com/christianlouis/pop_puller_to_gmail/sessions/ce88d4a8-d8c2-49b3-95a1-30592105a769
This commit is contained in:
@@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
- **Database-backed configuration**: `AppSetting` model and `ConfigService` for hybrid config (DB-first, env-var fallback)
|
||||
- Admin API endpoints for managing settings (`GET/PUT/DELETE /api/v1/settings`)
|
||||
- Default settings seeded into database on first startup (SMTP, processing, Gmail API, notifications)
|
||||
- Unit tests for `ConfigService` (24 tests covering resolution order, CRUD, SMTP helper, defaults)
|
||||
- Gmail API delivery documentation with comparison table (Gmail API vs SMTP forwarding)
|
||||
- GitHub issue templates (bug report, feature request, test needed)
|
||||
- Pull request template with comprehensive checklist
|
||||
- `docs/CODING_PATTERNS.md` with development best practices
|
||||
@@ -34,6 +39,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||
- Reached 57% test coverage (up from 54%)
|
||||
|
||||
### Changed
|
||||
- Configuration system now supports database-backed settings in addition to environment variables
|
||||
- Celery tasks (`tasks.py`) use `ConfigService` for SMTP config instead of raw `os.getenv()` calls
|
||||
- README updated with hybrid configuration docs, Gmail API vs SMTP comparison, and Apprise notifications
|
||||
- Architecture docs updated to reflect Gmail API service, hybrid config, and new API endpoints
|
||||
- Reorganized documentation into `docs/` directory
|
||||
- Improved error handling with specific exception types
|
||||
- Updated datetime usage to timezone-aware
|
||||
|
||||
Reference in New Issue
Block a user