Skip to content
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

Clarify Python/pip setup instructions in getting_started.rst #13061

Closed
Imama-Kainat opened this issue Feb 8, 2025 · 2 comments
Closed

Clarify Python/pip setup instructions in getting_started.rst #13061

Imama-Kainat opened this issue Feb 8, 2025 · 2 comments

Comments

@Imama-Kainat
Copy link

The "Python and Pip" section in getting_started.rst currently states:

"Managing Python installations can be quite tricky. We highly recommend using pyenv or if you are more comfortable using a package manager, then package managers like Homebrew on Mac or apt on Debian for this."

This text doesn't explain why managing Python installations is tricky. New developers might not understand the need for pyenv or other version management tools. It would be beneficial to explain that different projects (including Kolibri) may require specific Python versions, and that pyenv helps manage these versions effectively.

Suggested improvement:

"Managing Python installations can be challenging because different projects may require different Python versions. Using a tool like pyenv is highly recommended as it allows you to easily switch between Python versions. If you prefer using a package manager, you can use Homebrew on macOS or apt on Debian."

It might also be helpful to briefly explain what pyenv does (e.g., "pyenv is a tool that allows you to install and manage multiple Python versions on your system").

@Imama-Kainat
Copy link
Author

I'd like to take this issue

@MisRob
Copy link
Member

MisRob commented Feb 12, 2025

Hi @Imama-Kainat, thank you for the suggestion. I really like some formulations and considered your suggestions, however I worry about the documentation growing even larger than it already is. The benefits of version management and other development tools are general development knowledge, and people can search or learn it elsewhere.

@MisRob MisRob closed this as completed Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants