Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update info on setuptools for Python 3.12 #16731

Merged
merged 1 commit into from Feb 29, 2024

Conversation

cho-m
Copy link
Member

@cho-m cho-m commented Feb 23, 2024

Also update info for pip install --upgrade given PEP 668

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

Also update info for `pip install --upgrade` given PEP 668
@cho-m cho-m added the documentation Documentation changes label Feb 23, 2024
The Python formulae install [pip](https://pip.pypa.io/) (as `pip3`) and [Setuptools](https://pypi.org/project/setuptools/).
The Python formulae install [pip](https://pip.pypa.io/) (as `pip3`). Python@3.11 and older Python formulae also install [Setuptools](https://pypi.org/project/setuptools/).

Starting with Python@3.12, the bundled Python packages should be updated by reinstalling brewed Python. For older Python formulae, they can be updated as described below.
Copy link
Member Author

@cho-m cho-m Feb 23, 2024

Choose a reason for hiding this comment

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

Not sure of phrasing here, but pip install --upgrade will hit PEP 668, e.g.

python3 -m pip install --upgrade setuptools
error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try brew install
    xyz, where xyz is the package you are trying to
    install.

Went with should rather than must since it is possible to override via --break-system-packages.


Also not sure the differences in our choice of name style that occur in this doc, i.e.

  • Python 3.11
  • Python@3.11
  • python@3.11

@cho-m cho-m marked this pull request as ready for review February 24, 2024 00:34
@cho-m
Copy link
Member Author

cho-m commented Feb 29, 2024

May just merge this as is today (unless anyone adds review comment beforehand) and we can continue improving our docs in future PRs.

@cho-m cho-m merged commit 977ac20 into Homebrew:master Feb 29, 2024
25 checks passed
@cho-m cho-m deleted the setuptools branch February 29, 2024 19:17
@github-actions github-actions bot added the outdated PR was locked due to age label Apr 3, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation changes outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants