sbcrumb/nfoguard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Complete v0.6.0 documentation update and review

Browse Source 
📚 Documentation Updates:
• Updated CHANGELOG.md with comprehensive v0.6.0 feature list
• Enhanced README.md with new TV processing endpoints and examples
• Updated SETUP.md with required Sonarr API key configuration
• Enhanced TESTING.md with v0.6.0 TV testing procedures
• Updated .env templates with proper Sonarr requirements

🔧 Configuration Updates:
• Mark SONARR_API_KEY as REQUIRED for v0.6.0+ Enhanced TV NFOs
• Updated version examples from 0.5.1 to 0.6.0
• Added JSON response examples for new TV endpoints
• Clarified URL-safe vs URL-encoded endpoint options

📋 Complete File Review:
• Verified all Python imports are consistent across modules
• Confirmed all typing imports (Dict, Any, List, Optional) are present
• Validated configuration templates match actual requirements
• Added comprehensive testing procedures for TV enhancements

✅ Ready for Production:
• All endpoints documented with examples
• Configuration requirements clearly specified
• Testing procedures comprehensive for troubleshooting
• Backward compatibility maintained throughout
This commit is contained in:
SBCrumb
2025-09-11 10:10:05 -04:00
parent 52fa0b6060
commit 01cd31505a
6 changed files with 72 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+21 -1
View File
@@ -2,9 +2,29 @@
All notable changes to this project will be documented in this file.
## [Unreleased] - v0.6.0
## [Released] - v0.6.0 - 2025-09-11
### Added
- **📺 Enhanced TV Show Processing**: Comprehensive single season/episode capabilities
- **Single Season Processing**: `/tv/scan-season` endpoint for targeted season updates
- **Single Episode Processing**: `/tv/scan-episode` endpoint for individual episode handling
- **URL-Safe Endpoints**: JSON-based API calls avoid URL encoding issues with spaces/special characters
- **Enhanced Path Detection**: Automatically detects season directories and episode files
- **Database Integration**: Full episode date tracking and retrieval with `get_episode_date()`
- **🎬 Rich NFO Generation**: Full metadata integration from Sonarr API
- **Episode Titles**: Real episode names from Sonarr instead of generic S01E01 format
- **Plot Summaries**: Episode descriptions for better library browsing experience
- **Runtime Data**: Episode duration information for media players
- **Rating Integration**: IMDb ratings and vote counts for episodes
- **Backwards Compatible**: Existing basic NFOs still work, enhanced when Sonarr API available
- **⏰ NFOGuard Timestamps**: All NFO files now include processing timestamps
- **Creation Tracking**: Shows when NFOGuard created/updated each NFO file
- **Format**: `<!-- managed by NFOGuard at 2025-09-11T13:45:22+00:00 -->`
- **Audit Trail**: Helps track metadata management history
- **🔧 Enhanced TV Manual Scan**: Smart path detection for seasons and episodes
- **Season Detection**: `curl -X POST "manual/scan?path=/media/TV/Series/Season 13"`
- **Episode Detection**: `curl -X POST "manual/scan?path=/media/TV/Series/Season 13/episode.mkv"`
- **Automatic Processing**: Detects context and processes accordingly
- **🔐 Secure Configuration System**: Two-file configuration with automatic API key masking
- **Main `.env`**: Paths and preferences (safe to share for debugging)
- **Separate `.env.secrets`**: API keys and passwords (never committed to git)