Skip to content

Commit c7b0d62

Browse files
committed
Reference canonical Python version info source in contributor guide
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.
1 parent da69d84 commit c7b0d62

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,9 @@ To build Arduino Lint from sources you need the following tools to be available
8181

8282
If you want to run integration tests or work on documentation, you will also need:
8383

84-
- A working [Python](https://www.python.org/downloads/) environment, version 3.9 or later.
84+
- A working [Python](https://www.python.org/downloads/) environment.
85+
- The **Python** version in use is defined in the `tool.poetry.dependencies` field of
86+
[`pyproject.toml`](https://github.com/arduino/arduino-lint/blob/main/pyproject.toml).
8587
- [Poetry](https://python-poetry.org/docs/).
8688
- [**Node.js** / **npm**](https://nodejs.org/en/download/) - Node.js dependencies management tool.
8789
- The **Node.js** version in use is defined in the `engines.node` field of

0 commit comments

Comments
 (0)