add python instructions to README #671
Closed
Conversation
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
dalg24
reviewed
Apr 24, 2025
dalg24
reviewed
Apr 24, 2025
| We recommend using a virtual environment, e.g. if your system python is >= 3.12: | ||
|
|
||
| ```sh | ||
| python -m venv venv |
Member
There was a problem hiding this comment.
Is it recommended practice to call it "venv" as a default name?
Contributor
Author
There was a problem hiding this comment.
https://docs.python.org/3/library/venv.html
It says
Contained in a directory, conventionally named .venv or venv in the project directory, or under a container directory for lots of virtual environments, such as ~/.virtualenvs.
So I just picked one but you can name it anything you like
dalg24
reviewed
Apr 24, 2025
| ```sh | ||
| python -m venv venv | ||
| source venv/bin/activate | ||
| pip install -r build_requirements.txt |
Member
There was a problem hiding this comment.
Do you remember why we didn't just call it requirements.txt?
Contributor
Author
There was a problem hiding this comment.
Honestly I don't remember, I think some of the NGA folks did that on the initial switch to sphinx. I think requirements.txt is more conventional but I'm not sure
Contributor
Author
|
Replaced by #672 |
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.
No description provided.