fix(pypi): README documentation links now work on PyPI

teng-lin · claude · teng-lin · commit 8989b0decbd1 · 2026-01-10T09:58:43.000-05:00
- Add hatch-fancy-pypi-readme for build-time link transformation
- Convert relative links to version-tagged GitHub URLs at build time
- Relative links (e.g., docs/troubleshooting.md) become absolute URLs
  pointing to the exact installed version (/blob/v0.1.3/docs/...)
- Add prominent source repository link for PyPI users
- Bump version to 0.1.3

Co-Authored-By: Claude Opus 4.5 &lt;noreply@anthropic.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.3] - 2026-01-10
+
+### Fixed
+- **PyPI README links** - Documentation links now work correctly on PyPI
+  - Added `hatch-fancy-pypi-readme` plugin for build-time link transformation
+  - Relative links (e.g., `docs/troubleshooting.md`) are converted to version-tagged GitHub URLs
+  - PyPI users now see links pointing to the exact version they installed (e.g., `/blob/v0.1.3/docs/...`)
+- **Development repository link** - Added prominent source link for PyPI users to find the GitHub repo
+
 ## [0.1.2] - 2026-01-10
 
 ### Added
@@ -104,7 +113,8 @@ This is the initial public release of `notebooklm-py`. While core functionality
 - **Authentication expiry**: CSRF tokens expire after some time. Re-run `notebooklm login` if you encounter auth errors.
 - **Large file uploads**: Files over 50MB may fail or timeout. Split large documents if needed.
 
-[Unreleased]: https://github.com/teng-lin/notebooklm-py/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/teng-lin/notebooklm-py/compare/v0.1.3...HEAD
+[0.1.3]: https://github.com/teng-lin/notebooklm-py/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/teng-lin/notebooklm-py/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/teng-lin/notebooklm-py/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/teng-lin/notebooklm-py/releases/tag/v0.1.0
diff --git a/README.md b/README.md
@@ -10,6 +10,8 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Tests](https://github.com/teng-lin/notebooklm-py/actions/workflows/test.yml/badge.svg)](https://github.com/teng-lin/notebooklm-py/actions/workflows/test.yml)
 
+**Source & Development**: <https://github.com/teng-lin/notebooklm-py>
+
 > **⚠️ Unofficial Library - Use at Your Own Risk**
 >
 > This library uses **undocumented Google APIs** that can change without notice.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,8 +1,8 @@
 [project]
 name = "notebooklm-py"
-version = "0.1.2"
+version = "0.1.3"
 description = "Unofficial Python client for Google NotebookLM API"
-readme = "README.md"
+dynamic = ["readme"]
 requires-python = ">=3.10"
 license = {text = "MIT"}
 authors = [
@@ -50,9 +50,32 @@ all = ["notebooklm-py[browser,dev]"]
 notebooklm = "notebooklm.notebooklm_cli:main"
 
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "hatch-fancy-pypi-readme"]
 build-backend = "hatchling.build"
 
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+
+# Convert relative doc links to version-tagged absolute URLs
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '\]\(docs/'
+replacement = '](https://github.com/teng-lin/notebooklm-py/blob/v$HFPR_VERSION/docs/'
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '\]\(CHANGELOG\.md\)'
+replacement = '](https://github.com/teng-lin/notebooklm-py/blob/v$HFPR_VERSION/CHANGELOG.md)'
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '\]\(SECURITY\.md\)'
+replacement = '](https://github.com/teng-lin/notebooklm-py/blob/v$HFPR_VERSION/SECURITY.md)'
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]
+pattern = '\]\(LICENSE\)'
+replacement = '](https://github.com/teng-lin/notebooklm-py/blob/v$HFPR_VERSION/LICENSE)'
+
 [tool.hatch.build.targets.wheel]
 packages = ["src/notebooklm"]
 
diff --git a/src/notebooklm/__init__.py b/src/notebooklm/__init__.py
@@ -13,7 +13,7 @@
     See docs/troubleshooting.md for guidance on handling API changes.
 """
 
-__version__ = "0.1.2"
+__version__ = "0.1.3"
 
 # Public API: Authentication
 from .auth import DEFAULT_STORAGE_PATH, AuthTokens

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@`
`10`	`10`	`[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)`
`11`	`11`	`[![Tests](https://github.com/teng-lin/notebooklm-py/actions/workflows/test.yml/badge.svg)](https://github.com/teng-lin/notebooklm-py/actions/workflows/test.yml)`
`12`	`12`
	`13`	`+Source & Development: <https://github.com/teng-lin/notebooklm-py>`
	`14`	`+`
`13`	`15`	`> ⚠️ Unofficial Library - Use at Your Own Risk`
`14`	`16`	`>`
`15`	`17`	`> This library uses undocumented Google APIs that can change without notice.`