Merge pull request #298 from openvax/readme-github-alert

README: GitHub [!IMPORTANT] alert, kept PyPI-clean via setup.py

Author: iskandr

README.md

@@ -19,16 +19,13 @@ Have a bugfix or other contribution? We would love your help. See our [contribut
 
 ## 2.3.0 release candidate
 
-2.3.0 is currently a **release candidate** (`2.3.0rc3`), not yet a final
-release. It keeps the same API and pre-trained models as 2.2.x. Install it by
-pinning the version:
-
-    pip install mhcflurry==2.3.0rc3
-
-For now, `pip install --upgrade mhcflurry` still installs the latest stable
-release (2.2.x), because pip skips pre-releases unless you pin the version or
-pass `--pre`. Once 2.3.0 is released, `pip install --upgrade mhcflurry` will
-upgrade to it as usual.
+> [!IMPORTANT]
+> 2.3.0 is currently a release candidate (`2.3.0rc3`), not yet a final release.
+> It keeps the same public API and pre-trained models as 2.2.x. Install it with
+> `pip install --pre mhcflurry`, or pin the version with
+> `pip install mhcflurry==2.3.0rc3`. A plain `pip install --upgrade mhcflurry`
+> stays on the latest stable release (2.2.x) until 2.3.0 is final, since pip
+> skips pre-releases.
 
 2.3.0 adds speed and tooling for people who train their own models or run large
 prediction jobs:

mhcflurry/version.py

@@ -1 +1 @@
-__version__ = "2.3.0rc3"
+__version__ = "2.3.0rc4"

setup.py

@@ -27,6 +27,27 @@
     readme = ""
 
 
+def readme_for_pypi(text):
+    # PyPI's Markdown renderer (cmark-gfm) does not support GitHub's
+    # "> [!IMPORTANT]" alert syntax and would display the literal "[!IMPORTANT]"
+    # token. Convert each alert marker line to a bold label so the PyPI
+    # long_description renders as a clean blockquote. GitHub keeps the colored
+    # callout because README.md on disk is unchanged.
+    import re
+    labels = {
+        "NOTE": "Note",
+        "TIP": "Tip",
+        "IMPORTANT": "Important",
+        "WARNING": "Warning",
+        "CAUTION": "Caution",
+    }
+    return re.sub(
+        r"(?m)^(\s*>\s*)\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\][ \t]*$",
+        lambda m: "%s**%s**" % (m.group(1), labels[m.group(2)]),
+        text,
+    )
+
+
 with open("mhcflurry/version.py", "r") as f:
     version = re.search(
         r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE
@@ -96,7 +117,7 @@
             "mhcflurry": ["downloads.yml"],
         },
         install_requires=required_packages,
-        long_description=readme,
+        long_description=readme_for_pypi(readme),
         long_description_content_type="text/markdown",
         packages=find_packages(include=["mhcflurry", "mhcflurry.*"]),
     )