docs: Add note about unused standard libraries. by adityaSiso · Pull Request #7881 · mitmproxy/mitmproxy
Description
Added a note to the mitmproxy PyPI installation instructions regarding the skipping of unused standard library modules in precompiled binaries for keeping mitmproxy lightweight.
Checklist
- I have updated tests where applicable.
- I have added an entry to the CHANGELOG.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not about uvx, this is about our precompiled binaries.
Updated, Thanks for the information.
PS: This is my first open source pull request, so I’m a bit nervous about the changes, appreciate any feedback!
I'd instead add a note after line 60. Something like:
You might need to do this for standard library modules, as the standalone binaries only include a minimal Python environment.
The uvx --with option is already documented, so no need to repeat that.
I'd instead add a note after line 60. Something like:
You might need to do this for standard library modules, as the standalone binaries only include a minimal Python environment.
The
uvx --withoption is already documented, so no need to repeat that.
Thoughts on updating line 60 to something like:
If your mitmproxy addons require additional Python packages, consider installing mitmproxy from PyPI. The standalone binaries include only a minimal Python runtime, which may require you to install dependencies manually.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The confusing part here is that people don't expect parts of the standard library to be missing (see #7809 for an example) and "minimal python runtime" seems too vague to clarify that distinction.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters