diff --git a/docs/python/installation.md b/docs/python/installation.md index cc79b216..c0c45a33 100644 --- a/docs/python/installation.md +++ b/docs/python/installation.md @@ -5,211 +5,169 @@ In this section, we will guide you through the installation process of ???+ danger - Before you skip the content and proceed with the installation, we encourage - you to read our instructions. Following them, will save you some time - and potential headaches with the setup process! + Before you skip the content and proceed with the installation, we encourage you + to read our instructions. Following them, will save you some time and potential + headaches with the setup process! ---- +______________________________________________________________________ -## Step 1: :fontawesome-solid-download: Download +=== ":fontawesome-brands-windows: Windows" -We urge you to install **:fontawesome-brands-python: Python** `3.12.9`. -Visit the official website [python.org :octicons-link-external-16:](https://www.python.org/downloads/release/python-3129/), -scroll to the bottom of the page and download the installer for your operating -system. + Following video walks you through the installation steps for + :fontawesome-brands-windows: Windows. -Now, do not run the installer just yet - watch -the below video first! It will save you time! :ok_hand: +
+ +
-???+ tip ":fontawesome-brands-apple: Are you on Apple silicon?" + ???+ info + + If you prefer a written guide follow the next couple of sections. - If you are using an Apple silicon Mac (M1, ... M4), you can also pick - the `macOS 64-bit universal2 installer`. +

Step 1: :fontawesome-solid-download: Download

-## Step 2: :fontawesome-solid-arrow-pointer: Run installer + We recommend installing **:fontawesome-brands-python: Python** `3.14`! -No matter which operating system you're on, When installing Python, make sure -that you check the box `Add python to PATH`! + 1. Visit the official website + [python.org :octicons-link-external-16:](https://www.python.org){target="_blank" rel="noreferrer"} + 1. Navigate to **Downloads** + 1. A section **"Download for Windows"** will automatically appear + 1. Click the button **Python install manager** + 1. Locate the downloaded `.msix` file in your Downloads folder -Now run the Python installer. +

Step 2: :fontawesome-solid-arrow-pointer: Run installer

-=== ":fontawesome-brands-windows: Windows" + 1. Double-click the `.msix` file to launch the install manager. -
- -
+ 1. Click **"Install Python"** to begin the installation - After the successful installation, we recommend to open a command prompt - (use the Windows search with the keyword `cmd`) and verify the installation - by typing + 1. A new Terminal window will open - ```commandline - python --version - ``` + 1. **Optional:** If prompted with "Open Settings to modify App execution + aliases": - which should result in - - ```title="CMD Output" - Python 3.12.9 - ``` + - Type `y` and press ++enter++ + - In the Settings app, search for `alias` + - Navigate to **App execution aliases** + - Toggle the Python aliases **on** -=== ":fontawesome-brands-apple: macOS" - - ???+ info + ???+ info - Unfortunately, we do not have a installation video for macOS (yet). - If you're having any trouble, please reach out to us! + The app alias configuration is an optional step that may appear during + installation. It might not be necessary on your machine. Properly configured + aliases allow you to execute Python commands from the terminal. - Nevertheless, the installation process is straightforward. Double click the - downloaded `python-3.12.9-macos11.pkg` file and follow the installation - instructions. + 1. When prompted `Install CPython now? [Y/n]`: - Make sure to `Add python to PATH` during the installation process! + - Press ++enter++ to accept the default option (Yes) - After the successful installation, open a terminal (use the spotlight search - with the keyword `terminal`) and verify the installation by typing + 1. When prompted `View online help? [y/N]`: - ```bash - python3 --version - ``` + - Press ++enter++ to skip this step + - The terminal will close automatically - which should result in - - ``` - Python 3.12.9 - ``` +

Step 3: :fontawesome-solid-check-circle: Verify Installation

---- + 1. Open a new terminal window (use Windows search with the keyword + `terminal`) -## Step 3: :fontawesome-solid-check: Done! + ???+ info -If everything went smoothly, you have successfully installed -**:fontawesome-brands-python: Python**! You can now skip the -troubleshooting part and proceed with the next chapter. :party_popper: + If you are using Windows 10, search for **Command Prompt** (`cmd`) + instead of Terminal. All consecutive steps stay the same. -
- -
+ 1. Check your installation by running: ---- + ```commandline + python --version + ``` -## Optional: Troubleshooting + 1. You should see output similar to: -???+ info + ``` + Python 3.14.x + ``` - The troubleshooting section is specific to :fontawesome-brands-windows: - Windows. If you're on :fontawesome-brands-apple: macOS and encounter - issues, please reach out to us! + where `x` represents the specific patch version (e.g., `3.14.3` or + `3.14.4`). -### PATH issues +=== ":fontawesome-brands-apple: macOS" -If you didn't check the box `Add python.exe to PATH` during -installation, or you encounter an error message along the lines of + ???+ info -```commandline -'python' is not recognized as an internal or external command -``` + Unfortunately, we do not have a installation video for macOS (yet). + If you're having any trouble, reach out to us! + +

Step 1: :fontawesome-solid-download: Download

-you need to add Python to your PATH (the error means that -**:fontawesome-brands-python: Python** is simply not found). + We recommend installing **:fontawesome-brands-python: Python** `3.14`. -We cover two options to fix the PATH issue, either use the command prompt -or the GUI. + 1. Visit the official website + [python.org :octicons-link-external-16:](https://www.python.org){target="_blank" rel="noreferrer"} + 1. Navigate to the **Downloads** tab + 1. A section **"Download for macOS"** will automatically appear + 1. Click the **Python 3.14.x** button to download + 1. Locate the downloaded `.pkg` file in your Downloads folder -=== "Option 1: GUI" +

Step 2: :fontawesome-solid-arrow-pointer: Run installer

- **Step 1**: + 1. Double-click the `.pkg` file to launch the installer + 1. Follow the installation wizard: + - Click **Continue** through the introduction screens + - Accept the license agreement + - Click **Install** and enter your password if prompted + - Wait for the installation to complete - First, we need to find the path to the executable. - - Open the :fontawesome-brands-windows: Windows search and type `python`. - Select `Dateispeicherort öffnen` (open file location). Open the context menu - of `Python` (that's just a shortcut) and select `Eigenschaften` (properties) - :octicons-arrow-right-24: `Dateipfad öffnen` (open file path). - Lastly, copy the path of the newly opened explorer window. - - -
- Determine the path to the Python executable. -
- - **Step 2**: - - Now, we need to add the path to the environment variables. Again use - the :fontawesome-brands-windows: Windows search and type - `Umgebungsvariablen` (Environment variables). Select the Path value in the - `Benutzervariablen für ` (User variables) section. Click on - `Neu` (New) and paste the copied path. - -
- -
- Add the path to the user variables. -
-
+ ???+ danger -=== "Option 2: Command prompt" + **Important:** After installation completes, Finder will automatically open, + showing the Python installation folder. You **must** complete this final step: + + - Double-click the `Install Certificates.command` file + - A Terminal window will open and execute the certificate installation + - Wait for it to complete and close automatically + + This step is required for Python to make secure HTTPS connections. - **Step 1**: +

Step 3: :fontawesome-solid-check-circle: Verify Installation

- Determine the path to the **:fontawesome-brands-python: Python** executable - using the Python launcher `py` (which is part of the Python installation and - is on PATH by default). + 1. After the successful installation, open a terminal (use the spotlight + search with the keyword `terminal`) - - ```commandline - py -3.12 -c "import sys; print(sys.executable)" - ``` - - In my case, the output is: + 1. Verify the installation by typing: - - ```title="CMD Output" - C:\Users\ztklotz\AppData\Local\Programs\Python\Python312\python.exe - ``` - - Copy your path *without* the `python.exe` part. - - **Step 2**: - - Set the PATH variable using the command prompt. + ```bash + python3 --version + ``` - - ```commandline - setx PATH "%PATH%;" - ``` - - For instance (using my path): + 1. You should see output similar to: - - ```commandline - setx PATH "%PATH%;C:\Users\ztklotz\AppData\Local\Programs\Python\Python312" - ``` + ``` + Python 3.14.x + ``` -**Step 3**: + where `x` represents the specific patch version (e.g., `3.14.3` or + `3.14.4`). -Again, verify the installation by typing `python --version` within a command -prompt. +______________________________________________________________________ + +

Done!

+ +If everything went smoothly, you have successfully installed +**:fontawesome-brands-python: Python**! :tada: + +
+ +
---- +______________________________________________________________________ With **:fontawesome-brands-python: Python** installed, the next step is to set up a code editor. In the following section, we will install Visual Studio Code