|
| 1 | +# 🔔 Reminder: Restore Dynamic README Badges |
| 2 | + |
| 3 | +**Date to Complete:** November 13-14, 2025 (2 days after package publish) |
| 4 | + |
| 5 | +## Background |
| 6 | + |
| 7 | +The empathy-framework package was published to PyPI on November 12, 2025. Dynamic badges were temporarily removed because badge services (shields.io, codecov, etc.) need 24-48 hours to index new packages. |
| 8 | + |
| 9 | +## What to Do |
| 10 | + |
| 11 | +### Step 1: Test Badge URLs |
| 12 | + |
| 13 | +Check if these URLs now work (they should after 24-48 hours): |
| 14 | + |
| 15 | +1. **PyPI Version**: https://img.shields.io/pypi/v/empathy-framework.svg |
| 16 | +2. **Downloads**: https://img.shields.io/pypi/dm/empathy-framework.svg |
| 17 | +3. **Python Versions**: https://img.shields.io/pypi/pyversions/empathy-framework.svg |
| 18 | + |
| 19 | +Visit each URL in your browser - if you see a valid badge image (not an error), they're ready! |
| 20 | + |
| 21 | +### Step 2: Restore Badges in README.md |
| 22 | + |
| 23 | +Replace the current simplified badges section with: |
| 24 | + |
| 25 | +```markdown |
| 26 | +[](LICENSE) |
| 27 | +[](https://pypi.org/project/empathy-framework/) |
| 28 | +[](https://www.python.org/downloads/) |
| 29 | +[](https://pypi.org/project/empathy-framework/) |
| 30 | +[](https://github.com/Smart-AI-Memory/empathy-framework/actions/workflows/tests.yml) |
| 31 | +[](https://github.com/psf/black) |
| 32 | +[](https://github.com/astral-sh/ruff) |
| 33 | +``` |
| 34 | + |
| 35 | +### Step 3: Optional - Add CodeCov and OpenSSF Badges |
| 36 | + |
| 37 | +These require additional setup but can be added later: |
| 38 | + |
| 39 | +**CodeCov** (requires CI/CD coverage upload): |
| 40 | +```markdown |
| 41 | +[](https://codecov.io/gh/Smart-AI-Memory/empathy-framework) |
| 42 | +``` |
| 43 | + |
| 44 | +**OpenSSF Scorecard** (requires registration at https://securityscorecards.dev): |
| 45 | +```markdown |
| 46 | +[](https://securityscorecards.dev/viewer/?uri=github.com/Smart-AI-Memory/empathy-framework) |
| 47 | +``` |
| 48 | + |
| 49 | +### Step 4: Commit and Push |
| 50 | + |
| 51 | +```bash |
| 52 | +git add README.md |
| 53 | +git commit -m "docs: Restore dynamic badges after PyPI indexing" |
| 54 | +git push |
| 55 | +``` |
| 56 | + |
| 57 | +### Step 5: Delete This Reminder |
| 58 | + |
| 59 | +```bash |
| 60 | +rm BADGES_REMINDER.md |
| 61 | +git add BADGES_REMINDER.md |
| 62 | +git commit -m "chore: Remove badges reminder after completion" |
| 63 | +git push |
| 64 | +``` |
| 65 | + |
| 66 | +## Quick Commands |
| 67 | + |
| 68 | +```bash |
| 69 | +# Check if package is indexed (should return JSON with package info) |
| 70 | +curl https://pypi.org/pypi/empathy-framework/json |
| 71 | + |
| 72 | +# Check shield.io badge status |
| 73 | +curl -I https://img.shields.io/pypi/v/empathy-framework.svg |
| 74 | + |
| 75 | +# If you see HTTP 200, badges are ready! |
| 76 | +``` |
| 77 | + |
| 78 | +--- |
| 79 | + |
| 80 | +**Created:** November 12, 2025 |
| 81 | +**Target Date:** November 13-14, 2025 |
| 82 | +**Status:** ⏳ Waiting for badge services to index package |
0 commit comments