|
| 1 | +#!/usr/bin/env python3 |
| 2 | +""" |
| 3 | +Badge Generator for Hyperactive Documentation |
| 4 | +
|
| 5 | +Generates local SVG badges based on project information from pyproject.toml. |
| 6 | +This eliminates dependency on external badge services like shields.io. |
| 7 | +
|
| 8 | +Usage: |
| 9 | + python generate_badges.py |
| 10 | +
|
| 11 | +Output: |
| 12 | + - version.svg |
| 13 | + - python.svg |
| 14 | + - license.svg |
| 15 | + - sponsor.svg |
| 16 | +""" |
| 17 | + |
| 18 | +import re |
| 19 | +from pathlib import Path |
| 20 | + |
| 21 | +try: |
| 22 | + import tomllib |
| 23 | +except ImportError: |
| 24 | + import tomli as tomllib |
| 25 | + |
| 26 | + |
| 27 | +# Hyperactive color palette |
| 28 | +COLORS = { |
| 29 | + "primary": "#5D5D7A", |
| 30 | + "secondary": "#7070A0", |
| 31 | + "dark": "#4A4A65", |
| 32 | + "light": "#f8f9fa", |
| 33 | + "sponsor": "#0eac92", |
| 34 | + "label_bg": "#555", |
| 35 | +} |
| 36 | + |
| 37 | + |
| 38 | +def create_badge_svg(label: str, value: str, color: str, label_width: int = None, value_width: int = None) -> str: |
| 39 | + """ |
| 40 | + Create an SVG badge in shields.io flat-square style. |
| 41 | +
|
| 42 | + Args: |
| 43 | + label: Left side text (e.g., "version") |
| 44 | + value: Right side text (e.g., "5.0.2") |
| 45 | + color: Hex color for the value background |
| 46 | + label_width: Override calculated label width |
| 47 | + value_width: Override calculated value width |
| 48 | +
|
| 49 | + Returns: |
| 50 | + SVG string |
| 51 | + """ |
| 52 | + # Approximate width calculation (7px per character + padding) |
| 53 | + char_width = 6.5 |
| 54 | + padding = 10 |
| 55 | + |
| 56 | + lw = label_width or int(len(label) * char_width + padding * 2) |
| 57 | + vw = value_width or int(len(value) * char_width + padding * 2) |
| 58 | + total_width = lw + vw |
| 59 | + height = 20 |
| 60 | + |
| 61 | + svg = f'''<svg xmlns="http://www.w3.org/2000/svg" width="{total_width}" height="{height}"> |
| 62 | + <title>{label}: {value}</title> |
| 63 | + <!-- Label background --> |
| 64 | + <rect width="{lw}" height="{height}" fill="{COLORS['label_bg']}"/> |
| 65 | + <!-- Value background --> |
| 66 | + <rect x="{lw}" width="{vw}" height="{height}" fill="{color}"/> |
| 67 | + <!-- Label text --> |
| 68 | + <text x="{lw/2}" y="14" fill="#fff" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11" text-anchor="middle">{label}</text> |
| 69 | + <!-- Value text --> |
| 70 | + <text x="{lw + vw/2}" y="14" fill="#fff" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11" text-anchor="middle">{value}</text> |
| 71 | +</svg>''' |
| 72 | + |
| 73 | + return svg |
| 74 | + |
| 75 | + |
| 76 | +def create_simple_badge_svg(text: str, color: str, width: int = None) -> str: |
| 77 | + """ |
| 78 | + Create a simple single-section SVG badge. |
| 79 | +
|
| 80 | + Args: |
| 81 | + text: Badge text |
| 82 | + color: Background color |
| 83 | + width: Override calculated width |
| 84 | +
|
| 85 | + Returns: |
| 86 | + SVG string |
| 87 | + """ |
| 88 | + char_width = 7 |
| 89 | + padding = 16 |
| 90 | + w = width or int(len(text) * char_width + padding * 2) |
| 91 | + height = 20 |
| 92 | + |
| 93 | + svg = f'''<svg xmlns="http://www.w3.org/2000/svg" width="{w}" height="{height}"> |
| 94 | + <title>{text}</title> |
| 95 | + <rect width="{w}" height="{height}" fill="{color}"/> |
| 96 | + <text x="{w/2}" y="14" fill="#fff" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11" text-anchor="middle" font-weight="600">{text}</text> |
| 97 | +</svg>''' |
| 98 | + |
| 99 | + return svg |
| 100 | + |
| 101 | + |
| 102 | +def extract_python_versions(classifiers: list) -> str: |
| 103 | + """Extract Python version range from classifiers.""" |
| 104 | + versions = [] |
| 105 | + pattern = r"Programming Language :: Python :: (\d+\.\d+)" |
| 106 | + |
| 107 | + for classifier in classifiers: |
| 108 | + match = re.match(pattern, classifier) |
| 109 | + if match: |
| 110 | + versions.append(match.group(1)) |
| 111 | + |
| 112 | + if not versions: |
| 113 | + return "3.10+" |
| 114 | + |
| 115 | + versions.sort(key=lambda v: tuple(map(int, v.split(".")))) |
| 116 | + |
| 117 | + if len(versions) == 1: |
| 118 | + return versions[0] |
| 119 | + |
| 120 | + return f"{versions[0]} - {versions[-1]}" |
| 121 | + |
| 122 | + |
| 123 | +def main(): |
| 124 | + # Find pyproject.toml |
| 125 | + script_dir = Path(__file__).parent |
| 126 | + project_root = script_dir.parents[4] # Go up from docs/source/_static/images/badges |
| 127 | + pyproject_path = project_root / "pyproject.toml" |
| 128 | + |
| 129 | + if not pyproject_path.exists(): |
| 130 | + print(f"Error: pyproject.toml not found at {pyproject_path}") |
| 131 | + return |
| 132 | + |
| 133 | + # Read project info |
| 134 | + with open(pyproject_path, "rb") as f: |
| 135 | + pyproject = tomllib.load(f) |
| 136 | + |
| 137 | + project = pyproject.get("project", {}) |
| 138 | + version = project.get("version", "0.0.0") |
| 139 | + classifiers = project.get("classifiers", []) |
| 140 | + |
| 141 | + # Extract license from classifiers |
| 142 | + license_name = "MIT" # Default |
| 143 | + for classifier in classifiers: |
| 144 | + if "License :: OSI Approved ::" in classifier: |
| 145 | + license_name = classifier.split("::")[-1].strip() |
| 146 | + # Shorten common license names |
| 147 | + if "MIT" in license_name: |
| 148 | + license_name = "MIT" |
| 149 | + elif "BSD" in license_name: |
| 150 | + license_name = "BSD" |
| 151 | + elif "Apache" in license_name: |
| 152 | + license_name = "Apache 2.0" |
| 153 | + break |
| 154 | + |
| 155 | + python_range = extract_python_versions(classifiers) |
| 156 | + |
| 157 | + print(f"Generating badges for Hyperactive v{version}") |
| 158 | + print(f" Python: {python_range}") |
| 159 | + print(f" License: {license_name}") |
| 160 | + |
| 161 | + # Generate badges |
| 162 | + badges = { |
| 163 | + "version.svg": create_badge_svg("version", f"v{version}", COLORS["primary"]), |
| 164 | + "python.svg": create_badge_svg("python", python_range, COLORS["primary"]), |
| 165 | + "license.svg": create_badge_svg("license", license_name, COLORS["primary"]), |
| 166 | + "sponsor.svg": create_simple_badge_svg("GC.OS Sponsored", COLORS["sponsor"], width=110), |
| 167 | + } |
| 168 | + |
| 169 | + # Write badges |
| 170 | + for filename, svg_content in badges.items(): |
| 171 | + filepath = script_dir / filename |
| 172 | + with open(filepath, "w") as f: |
| 173 | + f.write(svg_content) |
| 174 | + print(f" Created: {filename}") |
| 175 | + |
| 176 | + print("\nDone! Badges generated successfully.") |
| 177 | + |
| 178 | + |
| 179 | +if __name__ == "__main__": |
| 180 | + main() |
0 commit comments