# Pre-Publication Checklist ## ✅ Completed Items - [x] LICENSE.md created with dual license terms - [x] CREDITS.md documenting all third-party dependencies - [x] CONTRIBUTING.md with contribution guidelines - [x] .gitignore configured properly - [x] License headers added to 1,926 Python files - [x] README.md updated with license and contact info - [x] __init__.py updated with license information ## ⚠️ Before Pushing to GitHub ### 1. Remove Sensitive Files Check for and remove any files containing: - [ ] API keys or tokens - [ ] Passwords or credentials - [ ] Private authentication cookies - [ ] Personal email addresses (beyond eric@historic.camera, eric@rollei.us) Files to check: ``` configs/instagram_cookies.json configs/reddit_cookies.json configs/twitter_cookies.json configs/auth_config.json ``` ### 2. Clean Development Files (Recommended) Already in .gitignore but should be deleted: - [ ] `.history/` folder (VS Code Local History) - [ ] `__pycache__/` directories - [ ] `desktop.ini` files - [ ] `.venv/` virtual environment folder Quick cleanup: ```powershell Remove-Item -Recurse -Force .history -ErrorAction SilentlyContinue Get-ChildItem -Recurse -Directory -Filter __pycache__ | Remove-Item -Recurse -Force Remove-Item desktop.ini -Force -ErrorAction SilentlyContinue ``` ### 3. Update Repository-Specific Information - [ ] Add your GitHub repository URL to CREDITS.md (line 196) - [ ] Consider adding your repository URL to README.md - [ ] Update any `[Your GitHub Repository URL]` placeholders ### 4. Test the Installation In a clean environment or with a colleague: ```powershell git clone cd PDF_tools .\check_install.ps1 # Test basic functionality ``` ### 5. Review Key Files One More Time - [ ] README.md - Is all information accurate? - [ ] LICENSE.md - Are the contact emails correct? - [ ] CREDITS.md - Are all dependencies listed? - [ ] .gitignore - Are all sensitive patterns included? ## 🚀 Publishing Steps ### Initialize Git (if not already done) ```powershell cd A:\Comfy25\ComfyUI_windows_portable\ComfyUI\custom_nodes\PDF_tools # Initialize repository git init # Add all files git add . # Check what will be committed git status # Review files that will be added (make sure no sensitive data) git diff --cached --name-only # First commit git commit -m "Initial commit: PDF Tools for ComfyUI - Complete PDF extraction and processing tools - Gallery-dl and yt-dlp downloader nodes - Florence2 and SAM2 AI vision integration - Comprehensive documentation and licenses " ``` ### Create GitHub Repository 1. Go to https://github.com/new 2. Repository name: `PDF_tools` or `ComfyUI-PDF-Tools` 3. Description: "PDF Tools for ComfyUI - Media downloaders, PDF extraction, and AI vision analysis" 4. Choose Public 5. **DO NOT** initialize with README (you already have one) 6. Create repository ### Push to GitHub ```powershell # Add remote (replace YOUR_USERNAME with your GitHub username) git remote add origin https://github.com/YOUR_USERNAME/PDF_tools.git # Rename branch to main git branch -M main # Push to GitHub git push -u origin main ``` ## 📋 Post-Publication Tasks ### Immediate - [ ] Verify repository looks correct on GitHub - [ ] Check that LICENSE.md is recognized by GitHub - [ ] Test clone and installation from GitHub - [ ] Add topics/tags to repository (comfyui, pdf, ocr, etc.) ### Optional Enhancements - [ ] Add badges to README (license, Python version) - [ ] Create first release/tag (v1.0.0) - [ ] Add repository to ComfyUI custom nodes list - [ ] Create GitHub Issues templates - [ ] Add CHANGELOG.md for future updates - [ ] Set up GitHub Actions for testing (if desired) ### Badges for README Add these at the top of README.md: ```markdown ![License: CC BY-NC 4.0](https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg) ![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg) ![ComfyUI](https://img.shields.io/badge/ComfyUI-Custom%20Nodes-orange.svg) ``` ## ⚖️ Legal Considerations ### Remember 1. **Dual License**: You're using CC BY-NC 4.0 for non-commercial use 2. **GPL Dependencies**: Some dependencies (gallery-dl, PyMuPDF AGPL) have copyleft licenses 3. **Commercial Users**: Need both your commercial license AND PyMuPDF commercial license 4. **Attribution**: Others must credit you when using your code ### For Commercial Licensing Create a simple process: 1. Email template for commercial inquiries 2. Pricing structure (if applicable) 3. License agreement template 4. Consider creating a separate COMMERCIAL_LICENSE.md ## 📞 Support Channels After publishing, consider: - [ ] Enable GitHub Issues for bug reports - [ ] Enable GitHub Discussions for Q&A - [ ] Add email for support in README - [ ] Decide on response time commitments ## 🎉 You're Ready! Once you've checked all the items above, your repository is ready for publication! **Questions?** - Review GITHUB_PREP_SUMMARY.md for detailed changes - Check individual documentation files - Contact: eric@historic.camera or eric@rollei.us --- **Good luck with your GitHub publication!** 🚀