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

New Tag: "Avoid System Python for Development" #2797

Merged
merged 12 commits into from
Mar 21, 2024
Merged

New Tag: "Avoid System Python for Development" #2797

merged 12 commits into from
Mar 21, 2024

Conversation

BruRdgz
Copy link
Contributor

@BruRdgz BruRdgz commented Oct 27, 2023

This new tag, "Avoid System Python for Development," highlights the drawbacks of using system Python for development work, providing solutions for developers. It promotes best practices to create isolated development environments and includes a helpful audio resource for further insights.

Relevant thread in PyDis

A tag for explaining why using system Python is not a good idea.
@n0Oo0Oo0b
Copy link
Contributor

n0Oo0Oo0b commented Oct 28, 2023

Was this tag approved anywhere? If it was approved somewhere like the #comunity-meta channel, it would be helpful to link it here for more context. Otherwise, you can suggest new tags for the bot by opening an issue at our meta repository here.

@BruRdgz
Copy link
Contributor Author

BruRdgz commented Oct 28, 2023

Was this tag approved anywhere? If it was approved somewhere like the #comunity-meta channel, it would be helpful to link it here for more context. Otherwise, you can suggest new tags for the bot by opening an issue at our meta repository here.

Yeah, Stelercus has advised me to open a draft PR for this particular issue.
I'll edit the PR's description for further clarity.

@swfarnsworth swfarnsworth self-requested a review October 29, 2023 01:59
@swfarnsworth
Copy link
Member

Thank you for writing this and opening this PR.

It's important that tags be as terse as possible, so as to drive a very specific point before losing the reader's attention. It's also important that the instructions are easy to follow for the target audience.

If we go forward with this tag, I'd like to first condense it significantly, to something along these lines:

Operating systems often come with a system Python interpreter that is used internally. While it may be suitable for executing one-off scripts, modifying it might interfere with its internal use, especially on Linux or macOS.

If you need to install packages or use a different Python version than the system's interpreter, try installing a separate interpreter.

And then list instructions for how to do this on Windows, macOS, and Linux.

Does this sound alright to you?

@BruRdgz
Copy link
Contributor Author

BruRdgz commented Nov 18, 2023

Thank you for writing this and opening this PR.

It's important that tags be as terse as possible, so as to drive a very specific point before losing the reader's attention. It's also important that the instructions are easy to follow for the target audience.

If we go forward with this tag, I'd like to first condense it significantly, to something along these lines:

Operating systems often come with a system Python interpreter that is used internally. While it may be suitable for executing one-off scripts, modifying it might interfere with its internal use, especially on Linux or macOS.
If you need to install packages or use a different Python version than the system's interpreter, try installing a separate interpreter.

And then list instructions for how to do this on Windows, macOS, and Linux.

Does this sound alright to you?

Your concerns about retaining the reader's attention are valid, but I still have some concerns about completely removing the observations about the consequences of tampering.
The point which the tag wishes to address is not only to instruct the reader about how to install/use alternatives, but to effectively push them away from possibly tampering with the system interpreter because of the ignorance of consequences associated with it - and I fear that, by removing those observations, the reader may disregard the tag as unnecessary advice and not feel encouraged to follow it.
Perhaps, we can compromise; I can condense the tag into something smaller and concise, while still retaining the bulk of the original observations that I find necessary to address.
Thoughts?

@Xithrius Xithrius added s: WIP Work In Progress p: 3 - low Low Priority a: tags Related to bot tags t: enhancement Changes or improvements to existing features labels Feb 3, 2024
@BruRdgz
Copy link
Contributor Author

BruRdgz commented Feb 27, 2024

I revisited this draft and incorporated the tag updates as per my previous suggestions. I've also condensed it for brevity.
Feedback from anyone interested in chipping in would be greatly appreciated!

@BruRdgz BruRdgz marked this pull request as ready for review February 29, 2024 02:53
@Xithrius Xithrius added s: needs review Author is waiting for someone to review and approve and removed s: WIP Work In Progress labels Mar 8, 2024
Copy link
Contributor

@import-pandas-as-numpy import-pandas-as-numpy left a comment

Choose a reason for hiding this comment

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

I'm okay with this. I think we can debate some of the wording a little bit, but ultimately I think it accomplishes the goal of succinctly answering the following:
"Why shouldn't I use the Python distributed with my OS?" and "What should I do instead?"

Technically installing a separate interpreter is done by Pyenv or similar tools, but I'm not sure engaging in that level of elaboration is going to make this any clearer to newcomers.

LGTM.

@ChrisLovering ChrisLovering merged commit 92fc4b9 into python-discord:main Mar 21, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: tags Related to bot tags p: 3 - low Low Priority s: needs review Author is waiting for someone to review and approve t: enhancement Changes or improvements to existing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants