Reference canonical Python version info source in contributor guide #802
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
Python and Python-based tools are used in the development and maintenance of the project. A standardized version of Python is used for these operations. The contributor will need to have this version installed if they want to perform the dependent operations. For this reason, the dependency on Python and the standardized version is documented in the contributor guide. Poetry is used for Python package dependencies management. Poetry installs dependencies into a virtual environment. For this reason, the Poetry configuration includes a Python version number, which must match the correct version of Python for the project. This configuration is stored in the `pyproject.toml` file. This is also used as the source of Python versioning information by all other parts of the infrastructure. In order to avoid the need to maintain an additional copy of that information in the contributor guide, it will be beneficial to instead direct the contributor to obtain the version info from the `pyproject.toml` file.
per1234
added
topic: documentation
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.
Python and Python-based tools are used in the development and maintenance of the project. A standardized version of Python is used for these operations. The contributor will need to have this version installed if they want to perform the dependent operations. For this reason, the dependency on Python and the standardized version is documented in the contributor guide.
Poetry is used for Python package dependencies management. Poetry installs dependencies into a virtual environment. For this reason, the Poetry configuration includes a Python version number, which must match the correct version of Python for the project. This configuration is stored in the
pyproject.tomlfile. This is also used as the source of Python versioning information by all other parts of the infrastructure (#799).In order to avoid the need to maintain an additional copy of that information in the contributor guide, it will be beneficial to instead direct the contributor to obtain the version info from the
pyproject.tomlfile.