Custom currency icons for deeds

[aldenstpage]

(This is not a launch blockerlocker)

Problem

We have a few designs for custom currencies in non-commercial deeds (ex) that aren't used anywhere. It would be nice to have the correct license icon used when available.

See the Icons section on this page.

[charan143-tech]

import re
from dataclasses import dataclass
from typing import List, Optional, Tuple

---------- Configuration ----------

Point these to your actual asset paths (SVG/PNG).

ICON_FILES = {
"cc": "icons/cc.svg",
"by": "icons/by.svg",
"sa": "icons/sa.svg",
"nd": "icons/nd.svg",
"nc": "icons/nc.svg", # Generic NC (used if no currency-specific icon exists)
"nc-dollar": "icons/nc-dollar.svg",
"nc-euro": "icons/nc-euro.svg",
"nc-pound": "icons/nc-pound.svg",
"nc-yen": "icons/nc-yen.svg",
"zero": "icons/cc-zero.svg", # CC0
"pd": "icons/pd.svg", # Public Domain Mark (PDM)
}

Preferred order of glyphs when composing

BASE_ORDER = ["cc", "by", "nc", "nd", "sa", "zero", "pd"]

@DataClass(frozen=True)
class LicenseIcons:
slugs: List[str] # e.g., ["cc", "by", "nc-dollar", "sa"]
files: List[str] # resolved file paths (based on ICON_FILES)

---------- Core logic ----------

_CC_RE = re.compile(
r"""
(?Pcc|creativecommons) # cc / creativecommons
(?:\s*[-/]\s*)?
(?P.*) # the rest: BY(-NC)?(-SA)? etc., or 'zero', 'publicdomain'
""",
re.IGNORECASE | re.VERBOSE,
)

Map a few common synonyms / shapes into normalized components

ALIAS = {
"by": "by",
"sa": "sa",
"nd": "nd",
"nc": "nc",
"nc-sa": "nc+sa",
"nc-nd": "nc+nd",
"zero": "zero",
"cc0": "zero",
"publicdomain": "pd",
"pdm": "pd",
"pd": "pd",
}

def _normalize_identifier(s: str) -> str:
"""Normalize a license string/URL into something like 'by-nc-sa-4.0' or 'zero'/'pd'."""
s = s.strip().lower()
# Pull main part out of a URL or long title if needed
m = _CC_RE.search(s)
if m:
s = m.group("rest")

# Remove url bits, parentheses, 'license', and extra words
s = re.sub(r"https?://\S+", "", s)
s = s.replace("license", "")
s = re.sub(r"[^\w\-/+\.]", " ", s)  # keep -, /, +, .
s = re.sub(r"\s+", "-", s).strip("-")

# Common single-token aliases (zero, pd etc.)
if s in ALIAS:
    return ALIAS[s]

# Strip version if present, keep it separate
version = None
vm = re.search(r"(?:^|[-/])(?P<v>\d+\.\d+|\d+)(?:$|[-/])", s)
if vm:
    version = vm.group("v")
    s = s.replace(vm.group("v"), "")
    s = re.sub(r"--+", "-", s).strip("-")

# Replace slashes with dashes (e.g., by-nc/sa → by-nc-sa)
s = s.replace("/", "-")

# Map words to canonical tokens
words = [w for w in re.split(r"[-+]", s) if w]
tokens = []
for w in words:
    w = ALIAS.get(w, w)
    if w in {"by", "nc", "nd", "sa", "zero", "pd"} and w not in tokens:
        tokens.append(w)

# Ensure BY comes first for standard CC licenses
if "zero" in tokens or "pd" in tokens:
    core = "zero" if "zero" in tokens else "pd"
    return core
if "by" in tokens:
    ordered = ["by"] + [t for t in ["nc", "nd", "sa"] if t in tokens]
    return "-".join(ordered + ([version] if version else []))

# Fallback: if nothing recognized, pass through
return "-".join(tokens + ([version] if version else [])) or "unknown"

def pick_nc_variant(preferred: Optional[str]) -> str:
"""
Choose the NonCommercial icon variant (currency) if available.
preferred can be one of: 'dollar', 'euro', 'pound', 'yen'.
Falls back to generic 'nc' if the currency-specific asset is missing.
"""
if not preferred:
return "nc"
slug = f"nc-{preferred}"
return slug if slug in ICON_FILES else "nc"

def license_icons(
license_str: str,
nc_currency: Optional[str] = None,
) -> LicenseIcons:
"""
Returns the list of icon slugs and their file paths for a given CC license.

Parameters
----------
license_str : str
    Examples:
      - "CC BY 4.0"
      - "CC-BY-SA-3.0"
      - "https://creativecommons.org/licenses/by-nc-nd/4.0/"
      - "CC0"
      - "Public Domain Mark"
nc_currency : Optional[str]
    If the license includes NC, pick a currency variant when you have
    a matching asset. One of: "dollar", "euro", "pound", "yen".

Returns
-------
LicenseIcons
    slugs: e.g. ["cc", "by", "nc-dollar", "sa"]
    files: e.g. ["icons/cc.svg", "icons/by.svg", ...]
"""
ident = _normalize_identifier(license_str)

# Special single-glyph cases
if ident == "zero":
    slugs = ["cc", "zero"]
elif ident == "pd":
    slugs = ["pd"]
else:
    parts = ident.split("-")
    slugs = ["cc"]  # base CC badge first
    # BY is required for standard licenses; add in order BY, NC, ND, SA if present
    for token in ["by", "nc", "nd", "sa"]:
        if token in parts:
            if token == "nc":
                slugs.append(pick_nc_variant(nc_currency))
            else:
                slugs.append(token)

# Keep a stable, sensible order
slugs = [s for s in BASE_ORDER if s in slugs] + [s for s in slugs if s not in BASE_ORDER]
files = [ICON_FILES[s] for s in slugs if s in ICON_FILES]
return LicenseIcons(slugs=slugs, files=files)

---------- Examples ----------

if name == "main":
examples = [
("CC BY 4.0", None),
("CC BY-NC-SA 4.0", "euro"),
("https://creativecommons.org/licenses/by-nc-nd/4.0/", "dollar"),
("CC0", None),
("Public Domain Mark", None),
]
for lic, cur in examples:
out = license_icons(lic, nc_currency=cur)
print(f"{lic} -> {out.slugs} -> {out.files}")

[TimidRobot]

@charan143-tech Thank you for the comment. However, we only accept submissions via pull request (PR).

For more information, please see the Contribution Guidelines — Creative Commons Open Source.

[charan143-tech]

@TimidRobot thank you ☺️