Migrate setup.py references to pyproject.toml. #182
Merged
Conversation
This file contains 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
bdice
requested review from
tcmoore3 and
klywang
and removed request for
a team
mikemhenry
approved these changes
Mar 14, 2023
| git clone https://github.com/glotzerlab/signac.git | ||
| cd signac | ||
| python setup.py install --user | ||
| pip install . |
There was a problem hiding this comment.
The --user flag works in pip, but are we assuming most are using virtual environments these days so the flag isn't needed?
There was a problem hiding this comment.
I’m just matching what we wrote in signac’s own package docs. Yes, I think that we are assuming users are in a virtual environment and/or know how to add that flag if needed.
There was a problem hiding this comment.
The vast majority of users copy and paste given instructions. I agree with removing --user as it is more likely to cause problems for users (i.e. when they update their Python version or use another Python installation with the same version).
|
LGTM! I like that you added installing from source without having to clone the repo |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes outdated references to setup.py in the docs.
Aligns with glotzerlab/signac#878, glotzerlab/signac-flow#704.
Checklist: