fermyon / developer

This is the home for developer.fermyon.com
https://developer.fermyon.com
Apache License 2.0
51 stars 66 forks source link

Update Developer Documentation to Include Python Version Requirement #1298

Closed kedaarsridhar20 closed 3 months ago

kedaarsridhar20 commented 3 months ago

Issue:

The current Spin Quickstart Guide does not mention that a specific version of Python is required for the setup and use of Spin when using Python. Specifically, the componentize-py package does not work unless Python version 3.10 or later is installed. This omission can lead to installation issues for developers following the guide who have older versions of Python.

Proposed Change:

Add a step in the "Install the Prerequisites" section of the Spin Quickstart Guide to instruct users to install Python 3.10 or later. The updated section should include the following information:

Prerequisite: Install Python 3.10 or later

Ensure that you have Python 3.10 or later installed on your system. You can check your Python version by running:

python3 --version

If you do not have Python 3.10 or later, you can install it by following the instructions here.

Rationale:

Including this prerequisite will help ensure that developers have the correct environment setup, preventing errors related to incompatible Python versions. This will improve the overall user experience and reduce setup-related issues.

Additional Information:

For more context on the requirement for Python 3.10 or later, please see the componentize-py documentation which specifies the version compatibility.