Skip to content

Add Python 3.9 requirement and WSL note to setup docs #13463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

NihalShinde4933
Copy link

Summary

This PR updates docs/getting_started.rst to:

  • Clarify that Python 3.9 is required for development.
  • Recommend using WSL instead of native Windows for Kolibri development.

Motivation

During setup, I encountered issues due to:

  • pre-commit needing Python 3.9+ (not mentioned explicitly).

  • Running Kolibri directly on Windows (unsupported as per maintainers).

This documentation improvement aims to save new contributors from similar issues.

Related Issue

Closes #13458

Notes

  • Fixed CRLF to LF line endings to avoid whole-file diffs.
  • Re-submission after feedback on previous PR.

Screenshots / Changes

Screenshot (60)-fotor-20250606135614

Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of other stale references that need to be updated.

@@ -68,12 +68,14 @@ Python and Pip

To develop on Kolibri, you'll need:

* Python 3.6+ (Kolibri doesn't currently support Python 3.12.0 or higher)
* Python 3.9 or higher (Note: Kolibri does not yet support Python 3.12 or above)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be updated to Python 3.14 or above

* `pip <https://pypi.python.org/pypi/pip>`__

Managing Python installations can be quite tricky. We *highly* recommend using `pyenv <https://github.com/pyenv/pyenv>`__ or if you are more comfortable using a package manager, then package managers like `Homebrew <http://brew.sh/>`__ on Mac or ``apt`` on Debian for this.

To install pyenv see the detailed instructions here :doc:`/howtos/installing_pyenv`.
..note::
If you are using a package manager, make sure to install a Python version compatible with Kolibri (3.9 or above, but below 3.12). If you're using `pyenv`, you can install it with a command like `pyenv install 3.9.9`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but below 3.14

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🚫 Setup Error: pre-commit==3.8.0 Not Found During pip install -r requirements/dev.txt
4 participants