Use a metadata hook to provide absolute links on PyPI

Author: mwouts

CHANGELOG.md

@@ -11,9 +11,14 @@ Jupytext ChangeLog
 - The `rst2md` conversion now works with `sphinx-gallery>=0.8`. Thanks to [Thomas J. Fan](https://github.com/thomasjpfan) for fixing this! ([#1334](https://github.com/mwouts/jupytext/pull/1334))
 - We have updated the JupyterLab extension dependencies ([#1300](https://github.com/mwouts/jupytext/pull/1300), [#1355](https://github.com/mwouts/jupytext/pull/1355), [#1360](https://github.com/mwouts/jupytext/pull/1360)). Thanks to [Mahendra Paipuri](https://github.com/mahendrapaipuri) for these PRs!
 
+**Added**
+- The context menu has a "New Text Notebook" entry. Thanks to [Mahendra Paipuri](https://github.com/mahendrapaipuri) for this PR ([#1365](https://github.com/mwouts/jupytext/pull/1365))!
+
 **Fixed**
 - We have added and fixed round trip tests on MyST Markdown notebooks ([#759](https://github.com/mwouts/jupytext/issues/759), [#789](https://github.com/mwouts/jupytext/issues/789), [#1267](https://github.com/mwouts/jupytext/issues/1267), [#1317](https://github.com/mwouts/jupytext/issues/1317))
 - The `--quiet` option now works with the `--pipe` mode of Jupytext CLI ([#1305](https://github.com/mwouts/jupytext/issues/1305))
+- Jupytext is now compatible with the cell toolbar extension - thanks to [Nicolas Brichet](https://github.com/brichet) for the fix! ([#1358](https://github.com/mwouts/jupytext/pull/1358))
+- The project description on PyPI now uses absolute links ([#1287](https://github.com/mwouts/jupytext/issues/1287))
 
 
 1.16.7 (2025-02-09)

pyproject.toml

@@ -9,7 +9,7 @@ license = { file = "LICENSE" }
 authors = [
     { name = "Marc Wouts", email = "[email protected]" },
 ]
-readme = "README.md"
+readme = "dist/README_with_absolute_links.md"
 requires-python = ">=3.8"
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -107,6 +107,9 @@ docs = [
 "jupytext" = "jupytext.cli:jupytext"
 "jupytext-config" = "jupytext_config.__main__:main"
 
+[tool.hatch.metadata.hooks.custom]
+path = "tools/absolute_links_in_readme.py"
+
 [tool.hatch.version]
 # Read version string from version.py and use it for the package
 path = "src/jupytext/version.py"

src/jupytext/version.py

@@ -1,3 +1,3 @@
 """Jupytext's version number"""
 
-__version__ = "1.17.0-dev"
+__version__ = "1.17.0rc0"

tools/absolute_links_in_readme.py

@@ -0,0 +1,40 @@
+import re
+from pathlib import Path
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+
+
+class AbsoluteLinksInReadme(MetadataHookInterface):
+    """Hook that processes README.md to make relative links absolute."""
+
+    def update(self, metadata):
+        """Process README.md when metadata is being prepared."""
+        readme_src_path = Path("README.md")
+        readme_output_path = Path("dist/README_with_absolute_links.md")
+        base_url = "https://github.com/mwouts/jupytext/blob/main/"
+
+        # Ensure the dist directory exists
+        readme_output_path.parent.mkdir(exist_ok=True)
+
+        self.convert_links(readme_src_path, readme_output_path, base_url)
+        return metadata
+
+    def convert_links(self, src_path, output_path, base_url):
+        """Convert relative links in README.md to absolute links."""
+        print(f"Processing {src_path} to generate {output_path} with absolute links")
+        content = src_path.read_text(encoding="utf-8")
+
+        # Find markdown links that don't start with http:// or https://
+        pattern = re.compile(r"\[([^\]]+)\]\((?!http)([^)]+)\)")
+
+        def replace_link(match):
+            text, url = match.groups()
+            if not url.startswith(("http://", "https://", "#")):
+                url = base_url + url
+            return f"[{text}]({url})"
+
+        new_content = pattern.sub(replace_link, content)
+
+        # Write the processed content to the output file
+        output_path.write_text(new_content, encoding="utf-8")
+        print(f"Generated {output_path} with absolute links")