bugfixes

Author: joergschultzelutter

setup.py

@@ -3,12 +3,14 @@
 from setuptools import setup, find_packages
 import os
 import re
+from pathlib import Path
+from urllib.parse import urljoin, urlsplit, urlunsplit
 
 # source path for the class' package. Amend if necessary
 PACKAGE_SOURCE_DIR = "path/to/class/directory"
 
 # Amend this section with your custom data
-PACKAGE_NAME="package-name"
+PACKAGE_NAME = "package-name"
 DESCRIPTION = "package-description"
 AUTHOR = "author-name"
 AUTHOR_EMAIL = "author@email.com"
@@ -23,30 +25,83 @@
     "Development Status :: 4 - Beta",
     "Framework :: Robot Framework",
 ]
-INSTALL_REQUIRES=[
-    "package_1", 
-    "package_2"
+INSTALL_REQUIRES = ["package_1", "package_2"]
+KEYWORDS = [
+    "Notifications",
+    "Notification Service",
+    "Push Notifications",
+    "Notifier",
+    "Alerts",
+    "Robot Framework",
 ]
-KEYWORDS=[
-    "Notifications", 
-    "Notification Service", 
-    "Push Notifications", 
-    "Notifier", 
-    "Alerts", 
-    "Robot Framework"
-]
-LICENSE="GNU General Public License v3 (GPLv3)"
+LICENSE = "GNU General Public License v3 (GPLv3)"
+
 
 def running_in_a_github_action():
     return os.getenv("GITHUB_ACTIONS") == "true"
 
+
+# Absolute URL to base repo; change this setting!
+BASE_URL = "https://github.com/joergschultzelutter/MY_REPO_NAME/blob/master/"
+
+# Markdown link recognition (will not work on image links)
+LINK_RE = re.compile(r"(?<!\!)\[(?P<text>[^\]]+)\]\((?P<href>[^)\s]+)\)")
+
+
+def is_absolute_url(href: str) -> bool:
+    return href.startswith(("http://", "https://", "mailto:"))
+
+
+def is_root_relative(href: str) -> bool:
+    return href.startswith("/")
+
+
+def looks_like_md(href: str) -> bool:
+    path = urlsplit(href).path
+    return path.lower().endswith(".md")
+
+
+def to_absolute_md(href: str) -> str:
+    parts = urlsplit(href)  # (scheme, netloc, path, query, fragment)
+    abs_url = urljoin(BASE_URL, parts.path)
+    return urlunsplit(
+        urlsplit(abs_url)._replace(query=parts.query, fragment=parts.fragment)
+    )
+
+
+def rewrite_md_links(md_text: str) -> str:
+    def repl(m: re.Match) -> str:
+        text = m.group("text")
+        href = m.group("href")
+
+        if (
+            not is_absolute_url(href)
+            and not is_root_relative(href)
+            and looks_like_md(href)
+        ):
+            href = to_absolute_md(href)
+
+        return f"[{text}]({href})"
+
+    return LINK_RE.sub(repl, md_text)
+
+
+def transform_file(filename: str) -> str:
+    in_path = Path(filename)
+    if not in_path.exists():
+        raise FileNotFoundError(filename)
+
+    content = in_path.read_text(encoding="utf-8")
+    transformed = rewrite_md_links(content)
+    return transformed
+
+
 if __name__ == "__main__":
-    # get README and use it as long description
-    with open("README.md", "r") as fh:
-        LONG_DESCRIPTION = fh.read()
+
+    LONG_DESCRIPTION = transform_file("README.md")
 
     GITHUB_PROGRAM_VERSION = ""
-    
+
     if running_in_a_github_action():
         # Only run this branch if we are part of a Github action. Otherwise, just skip
         # it as we won't be able to get the version info from Github anyway
@@ -56,9 +111,11 @@ def running_in_a_github_action():
         if not GITHUB_PROGRAM_VERSION:
             raise ValueError("Did not receive release label version info from GitHub")
     else:
-        if len(GITHUB_PROGRAM_VERSION == 0):
-            raise ValueError("Manual run requires a manually set GITHUB_PROGRAM_VERSION; change setup.py accordingly")
-    
+        if len(GITHUB_PROGRAM_VERSION) == 0:
+            raise ValueError(
+                "Manual run requires a manually set GITHUB_PROGRAM_VERSION; change setup.py accordingly"
+            )
+
     # Main setup branch
     setup(
         name=PACKAGE_NAME,
@@ -76,4 +133,3 @@ def running_in_a_github_action():
         install_requires=INSTALL_REQUIRES,
         keywords=KEYWORDS,
     )
-