Skip to content

docs: clarify Requests dependency guidance - #17

Draft
illuminati1911 wants to merge 1 commit into
masterfrom
requests-dependency-documentation
Draft

illuminati1911 wants to merge 1 commit into
masterfrom
requests-dependency-documentation

Conversation

@illuminati1911

Copy link
Copy Markdown
Collaborator

Summary

The README's historical Requests 2.4.0 timeout note is redundant under the current package dependency constraints.

  • Replace that note with a short explanation that Requests is installed automatically and a link to authoritative package metadata, avoiding another copy of the version range.
  • Use an absolute metadata link that works from GitHub and the package-index description.
  • Add an unreleased changelog entry.

Documentation only: runtime code, tests, dependency constraints and Python support policy are unchanged.

Related documentation work: googlemaps#542.

Verification

Using Python 3.10.20 and Requests 2.34.2:

  • Full test suite: 105 passed; statement coverage 88.67%, unchanged.
  • Full Sphinx 8.1.3 build passed with warnings treated as errors.
  • Distribution build/install and twine check --strict passed.
  • A clean-install smoke confirmed Requests was absent before installation, installed automatically with the built package, and satisfied its declared dependency range. The installed package imported successfully outside the source checkout.
  • Browser inspection confirmed the rendered README and changelog. Following the new metadata link displayed the actual upstream dependency declaration.

Updated README paragraph.

Verification limits

The configured Python 3.7 documentation interpreter is unavailable; the build used Python 3.10. The full multi-version CI matrix was not run. Existing setuptools packaging deprecation warnings remain.

@illuminati1911 illuminati1911 self-assigned this Oct 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant