Skip to content

Commit bef49c9

Browse files
GeneAIclaude
andcommitted
chore: Add reminder to restore badges after PyPI indexing
Created reminder file to restore dynamic badges on Nov 13-14, 2025, after badge services have had time to index the new package. Includes step-by-step instructions and test commands. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 5845a6f commit bef49c9

File tree

1 file changed

+82
-0
lines changed

1 file changed

+82
-0
lines changed

BADGES_REMINDER.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
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](https://img.shields.io/badge/License-Fair%20Source%200.9-blue.svg)](LICENSE)
27+
[![PyPI version](https://img.shields.io/pypi/v/empathy-framework.svg)](https://pypi.org/project/empathy-framework/)
28+
[![Python 3.10+](https://img.shields.io/pypi/pyversions/empathy-framework.svg)](https://www.python.org/downloads/)
29+
[![Downloads](https://img.shields.io/pypi/dm/empathy-framework.svg)](https://pypi.org/project/empathy-framework/)
30+
[![Tests](https://github.com/Smart-AI-Memory/empathy-framework/actions/workflows/tests.yml/badge.svg)](https://github.com/Smart-AI-Memory/empathy-framework/actions/workflows/tests.yml)
31+
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
32+
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](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+
[![codecov](https://codecov.io/gh/Smart-AI-Memory/empathy-framework/branch/main/graph/badge.svg)](https://codecov.io/gh/Smart-AI-Memory/empathy-framework)
42+
```
43+
44+
**OpenSSF Scorecard** (requires registration at https://securityscorecards.dev):
45+
```markdown
46+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/Smart-AI-Memory/empathy-framework/badge)](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

Comments
 (0)