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: recommend using pip instead of setuptools #9567

Merged
merged 1 commit into from
Sep 5, 2022

Conversation

humitos
Copy link
Member

@humitos humitos commented Aug 31, 2022

  • mention pip is the recommended way
  • mention setuptools is deprecated
  • remove setuptools from the examples in favor of pip

Related #8659


📚 Documentation previews 📚

- mention `pip` is the recommended way
- mention `setuptools` is deprecated
- remove `setuptools` from the examples in favor of `pip`

Related #8659
@humitos humitos requested a review from a team as a code owner August 31, 2022 11:46
@humitos humitos requested a review from ericholscher August 31, 2022 11:46
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

This is a good first step, but we should probably put the deprecation information somewhere? Seems like we should maybe have a page with a list, and the approximate date we expect to remove it?

@humitos
Copy link
Member Author

humitos commented Sep 1, 2022

@ericholscher Yes. I'm on board with creating a deprecation.rst page and list all the things we are deprecating there with deprecation and removal dates that we link from all these places. What is a good time frame for the final removal? 1, 2 or 3 months?

@ericholscher
Copy link
Member

@humitos I think it will depend on the feature. Since this one was a documented default up until today, I think we probably want a reasonably long timeline. I'd say 3 months from when we send a PR/email to all effected projects, but even that seems aggressive for something that's not deprecated by the ecosystem.

@humitos
Copy link
Member Author

humitos commented Sep 5, 2022

I think it's deprecated already. Python's official documentation refers to it as "Legacy version" and also has a note at the top: https://docs.python.org/3/install/

[...] The entire distutils package has been deprecated and will be removed in Python 3.12. [...]

@humitos
Copy link
Member Author

humitos commented Sep 5, 2022

I'm merging this PR to move forward with the changes in the documentation and avoid new projects using legacy workflows. We can keep discussing the proper final removal of this feature and the creation of the deprecation.rst page in the next iteration. I think updating the documentation is a good first step.

@humitos humitos merged commit 1600b57 into main Sep 5, 2022
@humitos humitos deleted the humitos/remove-setuptools-example branch September 5, 2022 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants