Split up into multiple pages and add more content

Author: wookie184

pydis_site/apps/content/resources/guides/python-guides/common-windows-issues.md

@@ -0,0 +1,113 @@
+---
+title: Common issues using Python on Windows
+description: This guide describes common issues you may run into when using Python on Windows and how to fix them.
+---
+
+## When I run `python` in the terminal I get no result, or the Windows Store opens!
+
+By default Windows has an alias for `python` in the terminal to guide you to install it from the Windows Store. We would not recommend that you install Python from the Microsoft Store, see why [here](./microsoft-store.md).
+
+To disable this alias, search "App execution aliases" in windows search and click on "Manage app execution aliases". In the list you should see two options with title "App Installer" and descriptions `python.exe` and `python3.exe`, disable them both.
+
+Note that if you are following instructions telling you to run a command starting with `python3`, those instructions are intended for Unix/macOS systems. Try just using `python` instead.
+
+If after doing this you have an issue with the Python command not being detected, see the below question.
+
+## When I try and run my code with `python` in the terminal I get an error saying the command was not recognised
+
+If you have not installed Python, you will need to do that. See #installing-python section.
+
+If you have installed python and are still getting the error, it is likely that you forgot to add to PATH when doing so. See [our guide on adding Python to PATH](./python-on-windows.md#changing-path) for how to fix this.
+
+You can also use the `py` launcher instead of `python` by just replacing `python` in your command with `py`. See [this guide](./python-on-windows.md#the-py-launcher) for more information on this.
+
+## I `pip` installed a package but when running my code get a `ModuleNotFoundError`
+
+* #### Are you actually getting a `ModuleNotFoundError`?
+
+    If you are using a code editor such as VSCode or Pycharm you may get a squiggly line under your import saying the module couldn't be found, it is possible that this is just an mistake by the editor, so try running your code with to ensure if it actually errors.
+
+    If your code runs fine, you could try restarting your editor - if you have newly installed a module it may just not have detected it yet. If that doesn't help, you may need to configure it to ensure it is looking for the module in the correct Python environment.
+
+* #### Was the install successful?
+
+    Look out for errors when installing the module you want. If you get an error, that's probably why you can't install it, so you should look into it. Often a google search will help with this.
+
+
+* #### Did you use the correct module name?
+
+    Double check that you haven't made a typo in the name you are importing, or in what you installed from PyPI, you need to make sure you get the name exactly as it should be.
+
+    Also **the name you should `import` may not be the same as the name you `pip install`**. Check the module's docs or PyPI page if you are unsure.
+    Examples of this are:
+
+    * [**opencv-python**](https://pypi.org/project/opencv-python/): You need to `pip install opencv-python`, but the import has to be `import cv2`
+    * [**discord.py**](https://pypi.org/project/discord.py/): You need to `pip install discord.py`, but the import has to be `import discord`
+    * [**python-dotenv**](https://pypi.org/project/python-dotenv/): You need to `pip install python-dotenv`, but the import has to be `import dotenv`
+
+
+* #### Are you installing to the same environment you're running your code from?
+
+    This is a very common issue. When you install a module from PyPI, you will install it into a single python executable, the one that the `pip` you invoked is referring to. This could be different to the one you are running the script from, usually because it's using a different python version, or a virtual environment.
+
+    * ##### I installed the module using pip
+
+        Run `pip -V` and look at the path returned it should be in the form `<PATH_TO_PYTHON>\Lib\site-packages\pip`.
+
+        Then put `import sys;print(sys.executable);sys.exit(0)` at the top (above imports!) of your python file, and run it. The result should be in the form `<PATH_TO_PYTHON>\python.exe`.
+
+        Now compare that `PATH_TO_PYTHON` to the one from `pip -V`. If they're different, this is the cause of the `ModuleNotFoundError`. See the relevant "I'm running with ..." sections below for how to resolve this.
+
+    * ##### I installed the module using PyCharm
+
+        PyCharm creates a virtual environment by default, so if you're installing the module using Pycharm you need to make sure you also run your code from Pycharm.
+
+    How to fix it depends on how you're running your code
+
+    * ##### I'm running my code with `python` from the terminal.
+
+        If you are using a virtual environment, ensure you have activated your venv before running `pip install`
+
+        * If you are running your code through your editor, make sure you have it set up to use the same editor you are `pip install`ing into.
+        * Use the `py` command to specify the python version you want to pip install into, e.g. `py -3.9 -m pip install numpy`, or to specify.
+        If you're still getting an error, the chances are you installed the module to a different environment to the one you're running python with. This is very common, and how best to fix it depends on what editor you're using.
+
+    * ##### I'm running my code with PyCharm
+
+        PyCharm creates a virtual environment for each project by default, so you need to make sure that virtual environment is activated before installing modules. The easiest way to do this is by `pip install`ing directly from the PyCharm editor terminal, where it will be activated by default.
+
+        You can also use PyCharm's GUI to install modules.
+
+    * ##### I'm running my code with VSCode
+
+        To run your code from the same environment you installed Python to, set the interpreter to the one at the path you found when running `pip -V` by following [this guide](https://code.visualstudio.com/docs/python/environments#_select-and-activate-an-environment). The path should be in the form `PATH_TO_PYTHON\python.exe`
+
+        Alternatively, you can pip install to the currently activated environment. If you have configured VSCode to use a virtual environment, it should automatically activate it when you open a new terminal, so running the `pip install` command in the VSCode terminal should work. If you are not using a virtual environment, you can use the `py` launcher to specify the installation you want to install to.
+
+## I `pip` installed a command line program but it isn't recognised
+
+You pip installed a command line program like `PyInstaller` that is intended to be run from the command line, but it does not work. Two common causes for this are
+
+* You are using Python from the Microsoft Store
+
+    To check if this is the case, type `pip -V`. If the path output includes something like `PythonSoftwareFoundation.Python.3.10_3.10.2288.0_x64__qbz5n2kfra8p0`, you are using Python from the Microsoft Store. To fix this you will either have to use the full path to the scripts you want to use, or uninstall the Microsoft Store Python and install Python properly with the online installer.
+
+* You manually modified your PATH Environment Variable incorrectly
+
+    If you added the path to your Python install as an environment variable
+
+Projects that add a command line program usually work by adding an executable to the `/Scripts` folder of your Python install. If you clicked "Add to PATH" when installing Python this folder will have been added to PATH, so anything there should be runnable directly from the command line. This should also be the case when using a virtual environment, as long as it is properly activated.
+
+If you added `Python` to PATH manually through environment variables, it is possible that you only added the executable but not the `/Scripts` folder.
+
+## I get a `SyntaxError` when trying to run `pip`,`python`, or another command.
+
+When you type `python` in the terminal you enter into the python REPL (read-evaluate-print loop). This lets you run lines of `Python` code, like `print("Hello World")`, without having to create a file.
+
+General commands like `pip` and `python` should be run in the terminal, not in the Python REPL. To exit the REPL, type `exit()` and press enter. You should then be able to run your commands normally.
+
+## I tried to uninstall Python by deleting the folder, now it doesn't work and I can't reinstall it!
+
+You should never uninstall your Python installation by deleting the folder it is in. If you have, you may need to edit Registry Keys to fully remove the installation. Doing this is dangerous and beyond the scope of this guide.
+
+To uninstall Python properly, run the installer for the version you want to uninstall and select "uninstall". If you no longer have the installer, you can re-download it first.

pydis_site/apps/content/resources/guides/python-guides/install-on-windows.md

@@ -0,0 +1,34 @@
+---
+title: Installing Python on Windows
+description: How to properly install python on windows
+---
+
+The recommended way to install Python on windows is directly from the [Python website's Downloads page](https://www.python.org/downloads/windows/). Installing Python from the Microsoft Store is not recommended as it can [cause issues](./microsoft-store.md).
+
+## Selecting an Installer
+There are many different installer options available from the downloads page. You should usually select the "Windows installer" option instead of the "Windows embeddable package". Some minor versions may not
+
+### Which version?
+Current Python versions follow the form `3.major.minor`. Major releases happen yearly and provide new features and breaking changes, whilst minor releases are more common and only include bug/security fixes.
+
+Installing the latest major version will give you access to Python's newest features. However, some modules may not support the newest versions straight away, so installing the second latest will help you avoid those issues. If you find you want some newer features or your module does not support your current version, you can always install another version as well.
+
+You should generally always install the newest minor version, although some may not provide an installer in which case you should find the newest that does.
+
+### 32-bit vs 64-bit?
+Install 64-bit python unless you have reason not to. With 32 bit you may run into memory limits if doing intensive operations (Python will be limited to using 4GB of memory), and some installed modules may not offer prebuilt wheels for 32 bit, potentially making installs slower or meaning you have to install build dependencies.
+
+If you get an error when installing 64-bit Python, your computer may not support it. To find out if this is the case, search "About your PC" in windows search and open the settings page. Then look for the "System Type" option under "Device Specifications". It should say "64-bit operating system, x64-based processor" if you have support. You need a 64 bit processor and OS to install 64 bit programs.
+
+## Running the installer
+When you run the installer you should see a screen like this:
+
+![python_installer_screen](https://user-images.githubusercontent.com/22353562/126144479-cfe6bd98-6d2e-47c3-b6b3-5de9f2656e9a.png)
+
+Make sure you tick "Add Python 3.x to Path". This allows you to use the `python` and `pip` commands in your terminal to invoke Python. If you already have a Python installation on your PATH and don't want this one to override it, don't tick this.
+
+If you installed Python without adding to PATH and now want to add it, see (#changing-path)[#changing-path].
+
+Then simply click install, and wait for the install to finish!
+
+To test your installation, type "cmd" in the windows search bar and select "Command Prompt" to open a terminal (make sure it's opened *after* installation has finished) type `python -V`, and press enter. If it outputs your python version, you've successfully installed Python. (if you didn't add to PATH, you can use [the py launcher](./python-on-windows.md#the-py-launcher) to test instead).

pydis_site/apps/content/resources/guides/python-guides/microsoft-store.md

@@ -0,0 +1,16 @@
+---
+title: Why not to install Python from the Microsoft Store
+description: This guide explains the issues with using Python installed from the Microsoft Store
+---
+
+Microsoft provides a Python app on the Microsoft Store as an alternative to using the [Standard Installer](https://www.python.org/downloads/). We would recommend that you use the standard installer wherever possible.
+
+Here are some common issues caused when using Python from the Microsoft Store:
+
+* Any command line tools like `black` or `pyinstaller` won't work directly. This happens because they work by adding an executable to the `Scripts/` directory, which isn't added to PATH on the Microsoft Store version of Python.
+
+* Some modules and scripts wont work with it because of restricted permissions. This is explained here: https://docs.python.org/3/using/windows.html#redirection-of-local-data-registry-and-temporary-paths
+
+* `python.exe` isn't added to PATH, but `pip.exe` is. This makes it easy to have an inconsistent `pip` and `python`. The `pip` is under the `C:\Users\username\AppData\Local\Microsoft\WindowsApps` entry, which wouldn't obviously have anything python related in it. If you add your normal python install path below this one the `pip` will be overridden by the `WindowsApps` one but the `python` one wont as it's overwriting the app execution alias.
+
+* The app execution alias behaviour is confusing. If you use the online installer and for get to tick the box to to add to path, when you try and use `python`, you either get no output or the windows store opens. This hides the command not found error which would have indicated that their install didn't work as expected.