Skip to content

README: Add more emphasis on security and longevity#3727

Merged
pquentin merged 4 commits intourllib3:mainfrom
shazow:improve-readme
Dec 19, 2025
Merged

README: Add more emphasis on security and longevity#3727
pquentin merged 4 commits intourllib3:mainfrom
shazow:improve-readme

Conversation

@shazow
Copy link
Copy Markdown
Member

@shazow shazow commented Dec 4, 2025

Added a point about security to the features and another note about our maintainers.

I want to highlight that urllib3 prioritizes security/safety/longevity in ways that most other projects don't, not sure this is sufficient but perhaps a good starting point.

I don't feel very strongly about this change, feel free to close for now and stew on it for later iterations. Just wanted to get something pushed from our discussion.

@shazow shazow assigned pquentin and illia-v and unassigned pquentin and illia-v Dec 4, 2025
@shazow shazow requested review from illia-v and pquentin December 4, 2025 15:36
@shazow
Copy link
Copy Markdown
Member Author

shazow commented Dec 4, 2025

Let me know if this is desirable, I can add a changelog entry if we want. :)

@sigmavirus24 sigmavirus24 added the Skip Changelog Pull requests that don't require a changelog entry label Dec 4, 2025
Comment thread README.md
Comment thread README.md Outdated
Comment on lines +89 to +90
Meet our alumni of lead maintainers since 2008:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this list of all maintainers, not only lead ones?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrased

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, "alumni" are past maintainers, but some of us are still active in that list!

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pquentin What's better phrasing? "Meet our maintainers since 2008"?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated, lmk what you think. :)

@shazow
Copy link
Copy Markdown
Member Author

shazow commented Dec 4, 2025

I reworked the README a bit more, taking more of the phrasing we started using in the docs landing page ("Much of the Python ecosystem already uses urllib3 and you should too"), and I merged the intro example into the Documentation section now called "Getting Started" which I think is fairly idiomatic these days for READMEs.

Again, feel free to push back on any of these changes but please take another look.

illia-v
illia-v previously approved these changes Dec 5, 2025
Copy link
Copy Markdown
Member

@illia-v illia-v left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

shazow and others added 2 commits December 5, 2025 10:03
Added a point about security to the features and another note about our maintainers.

I want to highlight that urllib3 prioritizes security/safety/longevity in ways that most other projects don't, not sure this is sufficient but perhaps a good starting point.
Taking some of the phrasing from the docs landing page
Comment thread README.md Outdated
@pquentin pquentin merged commit 14223c4 into urllib3:main Dec 19, 2025
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog Pull requests that don't require a changelog entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants