BUG#37453587: Github links in PyPI project's pages do not work

javier-trevino · javier-trevino · commit bbc36d5642eb · 2025-02-21T09:16:58.000-06:00
Fixed the links displayed in the PyPI project pages that are meant to open metadata files in GitHub such as LICENSE.txt.

Change-Id: I53ecacb3f70f9e86920aeef5d87d5848e7981513
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -3,11 +3,16 @@ MySQL Connector/Python - Release Notes & Changes
 ====================================================
 
 MySQL Connector/Python
-Copyright (c) 2009, 2024, Oracle and/or its affiliates.
+Copyright (c) 2009, 2025, Oracle and/or its affiliates.
 
 Full release notes:
  http://dev.mysql.com/doc/relnotes/connector-python/en/
 
+v9.3.0
+======
+
+- BUG#37453587: Github links in PyPI project's pages do not work
+
 v9.2.0
 ======
 
diff --git a/mysql-connector-python/setup.py b/mysql-connector-python/setup.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2009, 2024, Oracle and/or its affiliates.
+# Copyright (c) 2009, 2025, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -48,6 +48,7 @@
 except ImportError:
     DistWheel = None
 
+GITHUB_URL = "https://github.com/mysql/mysql-connector-python"
 METADATA_FILES = (
     "README.txt",
     "README.rst",
@@ -116,7 +117,7 @@ def main() -> None:
             "Documentation": "https://dev.mysql.com/doc/connector-python/en/",
             "Downloads": "https://dev.mysql.com/downloads/connector/python/",
             "Release Notes": "https://dev.mysql.com/doc/relnotes/connector-python/en/",
-            "Source Code": "https://github.com/mysql/mysql-connector-python",
+            "Source Code": GITHUB_URL,
             "Bug System": "https://bugs.mysql.com/",
             "Slack": "https://mysqlcommunity.slack.com/messages/connectors",
             "Forums": "https://forums.mysql.com/list.php?50",
@@ -201,6 +202,11 @@ def get_long_description() -> str:
                     if repl_name == "repl" or repl_name.endswith("mysql"):
                         block_text = block_text.replace(repl_source, repl_target)
             long_description = long_description.replace(block_match.group(), block_text)
+    # Make replacements for files that are directly accessible within GitHub but not within PyPI
+    files_regex_fragment = "|".join(mf.replace(".", r"\.") for mf in METADATA_FILES)
+    long_description = re.sub(pattern=rf"\<(?P<file_name>{files_regex_fragment})\>",
+                              repl=f"<{GITHUB_URL}/blob/trunk/\g<file_name>>",
+                              string=long_description)
     return long_description
 
 
diff --git a/mysqlx-connector-python/setup.py b/mysqlx-connector-python/setup.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) 2009, 2024, Oracle and/or its affiliates.
+# Copyright (c) 2009, 2025, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -49,6 +49,7 @@
     DistWheel = None
 
 
+GITHUB_URL = "https://github.com/mysql/mysql-connector-python"
 METADATA_FILES = (
     "README.txt",
     "README.rst",
@@ -128,7 +129,7 @@ def main() -> None:
             "Documentation": "https://dev.mysql.com/doc/connector-python/en/",
             "Downloads": "https://dev.mysql.com/downloads/connector/python/",
             "Release Notes": "https://dev.mysql.com/doc/relnotes/connector-python/en/",
-            "Source Code": "https://github.com/mysql/mysql-connector-python",
+            "Source Code": GITHUB_URL,
             "Bug System": "https://bugs.mysql.com/",
             "Slack": "https://mysqlcommunity.slack.com/messages/connectors",
             "Forums": "https://forums.mysql.com/list.php?50",
@@ -208,6 +209,11 @@ def get_long_description() -> str:
                     if repl_name == "repl" or repl_name.endswith("mysqlx"):
                         block_text = block_text.replace(repl_source, repl_target)
             long_description = long_description.replace(block_match.group(), block_text)
+    # Make replacements for files that are directly accessible within GitHub but not within PyPI
+    files_regex_fragment = "|".join(mf.replace(".", r"\.") for mf in METADATA_FILES)
+    long_description = re.sub(pattern=rf"\<(?P<file_name>{files_regex_fragment})\>",
+                              repl=f"<{GITHUB_URL}/blob/trunk/\g<file_name>>",
+                              string=long_description)
     return long_description
 
 
