d818a8b6a8
Major README overhaul with complete deployment and configuration guide. Moved old docs to tests/ folder for archive. README.md UPDATES (880 lines - completely rewritten): ✓ Table of contents with navigation ✓ Complete overview of all 4 workflows + daily report ✓ Detailed authentication section (OAuth2 vs mTLS) ✓ Box-config.json location explanation ✓ Server deployment step-by-step guide ✓ Database setup (Docker + native PostgreSQL) ✓ Cron job examples for all workflows ✓ Comprehensive troubleshooting section ✓ Security checklist ✓ Monitoring and log rotation details ✓ Common SQL queries ✓ File structure diagram KEY SECTIONS ADDED: 1. What's Included - All 5 scripts explained 2. Quick Start - Local setup guide 3. Server Deployment - 6-step process with commands 4. Workflows - Detailed process for each (A1→A2, A5→A6, B1→B2, A2→A3, Daily Report) 5. Authentication - OAuth2 vs mTLS with examples 6. Configuration - All .env variables documented 7. Database - Schema, setup, queries 8. Monitoring - Logs, emails, database queries 9. Troubleshooting - Common issues + solutions 10. File Structure - Complete directory tree BOX-CONFIG.JSON LOCATION DOCUMENTED: ✓ Must be one folder up from Python-Version ✓ Referenced as ../Box-config.json in config.yaml ✓ Server deployment instructions include copying both files ✓ Troubleshooting section explains file not found errors MTLS DOCUMENTATION: ✓ Different base URL explained (dev-auth.app-api.ferrero.com) ✓ --auth-pfx flag usage ✓ Whitelisted IP requirement noted ✓ Certificate testing commands REORGANIZATION: - Moved old DEPLOYMENT.md → tests/DEPLOYMENT.md (archive) - Moved old WORKFLOW_DIAGRAMS.md → tests/WORKFLOW_DIAGRAMS.md (archive) - New DEPLOYMENT_GUIDE.md is the current deployment doc - README.md is now comprehensive one-stop documentation Changes: - Python-Version/README.md (completely rewritten, 880 lines) - Moved 2 old docs to tests/ folder - Added test files to tests/ folder 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
18 KiB
18 KiB