Skip to content

Commit 9fdce17

Browse files
authored
Prevent late discovery of Linux Python compatibility issues (#545)
Updates the python installation instructions to ensure that the "you must use system python" directive isn't missed on Linux.
1 parent e93eba1 commit 9fdce17

2 files changed

Lines changed: 19 additions & 19 deletions

File tree

docs/spelling_wordlist

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ miniconda
2020
pre
2121
Pre
2222
px
23+
pyenv
2324
Pygame
2425
pytest
2526
runtime

docs/tutorial/tutorial-0.rst

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,15 @@ The first thing we'll need is a working Python interpreter.
3434
alphas, betas, and release candidates unless you *really* know what you're
3535
doing.
3636

37+
You can also install Python through `homebrew
38+
<https://docs.brew.sh/Homebrew-and-Python>`__, use `pyenv
39+
<https://github.com/pyenv/pyenv#simple-python-version-management-pyenv>`__
40+
to manage multiple Python installs, or use `Anaconda
41+
<https://docs.anaconda.com/anaconda/install/>`__ or `Miniconda
42+
<https://docs.conda.io/en/latest/miniconda.html>`__. It doesn't matter
43+
*how* you've installed Python - it only matters that you can run ``python3``
44+
from your terminal and get a working Python interpreter.
45+
3746
.. group-tab:: Linux
3847

3948
If you're on Linux, you'll install Python using the system package manager
@@ -45,34 +54,24 @@ The first thing we'll need is a working Python interpreter.
4554

4655
Support for Raspberry Pi is limited at this time.
4756

57+
**Important:** You *must* use the system Python provided by your operating
58+
system. Alternative Python installations (pyenv, Anaconda, manually compiled
59+
Python, etc.) will prevent you from successfully packaging your application
60+
for distribution in later steps of this tutorial.
61+
4862
.. group-tab:: Windows
4963

5064
If you're on Windows, you can get the official installer from `the Python
5165
website <https://www.python.org/downloads>`_. You can use any stable version
5266
of Python from 3.9 to 3.13. We'd also advise avoiding alphas, betas, and
5367
release candidates unless you *really* know what you're doing.
5468

55-
.. admonition:: Alternative Python distributions
56-
57-
There are lots of different ways of installing Python. You can install
58-
Python through `homebrew
59-
<https://docs.brew.sh/Homebrew-and-Python>`__. You can use `pyenv
60-
<https://github.com/pyenv/pyenv#simple-python-version-management-pyenv>`__
61-
to manage multiple Python installs on the same machine. Windows users
62-
can install Python from the Windows App Store. Users from a data science
63-
background might want to use `Anaconda
69+
You can also install Python from the Windows App Store, or use `Anaconda
6470
<https://docs.anaconda.com/anaconda/install/>`__ or `Miniconda
65-
<https://docs.conda.io/en/latest/miniconda.html>`__.
66-
67-
If you're on macOS or Windows, it doesn't matter *how* you've installed
68-
Python - it only matters that you can run ``python3`` from your operating
69-
system's command prompt/terminal application, and get a working Python
70-
interpreter.
71+
<https://docs.conda.io/en/latest/miniconda.html>`__. It doesn't matter
72+
*how* you've installed Python - it only matters that you can run ``python3``
73+
from your command prompt and get a working Python interpreter.
7174

72-
If you're on Linux, you *must* use the system Python provided by your
73-
operating system. You will be able to complete *most* of this tutorial using
74-
a non-system Python, but you won't be able to package your application for
75-
distribution to others.
7675

7776
.. _install-dependencies:
7877

0 commit comments

Comments
 (0)