Proofread, reorganized, and added to all the "Python on Windows" guides #794

discretegames · 2022-11-08T14:16:23Z

As discussed in #dev-contrib I wanted to write a guide for the site on how to add Python to Path since it comes up so often in help channels. wookie already wrote a lot of good stuff on that and other Windows matters (see #773) which here I expanded on and added lots of instructional screenshots.

The changes I've made are as follows (they're all on the add-windows-guide branch):

Big changes:

Reorganized the "Python on Windows" and "Installing Python on Windows" guides into one guide that has installing, py launcher, and venv sections.
- This includes new detailed screenshotted step by step instructions of "our" recommended way of installing, starting from the python.org/downloads yellow button. Want input to make sure "our" really represents PyDis.
- wookies stuff is still there but has been much rewritten and expanded upon.
Moved the Windows Path info to it's own "Adding Python to the Path" guide that has two sections based on wookies stuff.
- Safe method of having the installer add to Path. Detailed steps with screenshots.
- Advanced method of manually editing the Path. Detailed steps with screenshots.

Smaller changes:

Proofread and did a few formatting changes, like using quote boxes, to "Common issues using Python on Windows" guide. Added links and tidbits here and there.
Proofread and added some more drawbacks and images to "Why not to install Python from the Microsoft Store" guide.
Proofread and added WSL to "Unix-style Python Environment" guide.
Tweaked the slugs, titles, and descriptions to fit new content and so the guides appear in a nice order in folder.
Used the VSCode Rewrap plugin to make markdown paragraphs 120 line width. (Mostly for my own sanity while editing.)

(This is my first time contributing and first PR here 😅 so I really apologize if I'm doing something wrong like having too many changes at once that are tricky to review.)

…lanned changes and have nice order

… normalized to 120 wide with rewrap vsc ext)

… fixed links

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

shtlrs · 2022-11-08T16:11:44Z

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

+    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 your editor to ensure it is looking for the


Actually, some editors can still show that error even if you're showing the correct virtual environment with the installed package.
I think it was opencv IIRC.

Is that this https://stackoverflow.com/questions/34365044/pycharm-does-not-recognize-cv2-as-a-module ?
Where the fix is something like from cv2 import cv2. Could add a note to that SO link.

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

shtlrs

I've only had a look on two files but it looks good so far.
I'll try to have a look at the rest after work.

Beautiful content, thanks to you both for this. (@wookie184)

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

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

…/common-issues.md Co-authored-by: Amrou Bellalouna <48383734+shtlrs@users.noreply.github.com>

…python-discord-site into add-windows-guide

wookie184

Looks great! I have some suggestions, feel free to disagree with any of them :)

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

pydis_site/apps/content/resources/guides/python-guides/windows/installing-and-using-python.md

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

…/installing-and-using-python.md Co-authored-by: wookie184 <wookie1840@gmail.com>

…/common-issues.md Co-authored-by: wookie184 <wookie1840@gmail.com>

…/installing-and-using-python.md Co-authored-by: wookie184 <wookie1840@gmail.com>

…/putting-python-on-path.md Co-authored-by: wookie184 <wookie1840@gmail.com>

…python-discord-site into add-windows-guide

discretegames · 2022-11-13T02:52:35Z

One thing I wanted to be sure to resolve is whether or not the yellow downloads button on https://www.python.org/downloads/ really does download the best version the suits the computer, since I said it did in the "Recommended Installed" tutorial:

Go to python.org/downloads and click the big yellow "Download Python 3.x.x" button near the top of the page. That should start the download of the latest Windows Python installer that best suits your computer.

On Win 10 64-bit and Linux (what I'm able to test) it seems to, but I haven't been able to make sure the button downloads the 32-bit installer on a 32-bit machine. (And couldn't find code for the OS check in the pythondotorg repo.)

wookie184 · 2022-11-13T15:39:14Z

One thing I wanted to be sure to resolve is whether or not the yellow downloads button on https://www.python.org/downloads/ really does download the best version the suits the computer, since I said it did in the "Recommended Installed" tutorial:

Go to python.org/downloads and click the big yellow "Download Python 3.x.x" button near the top of the page. That should start the download of the latest Windows Python installer that best suits your computer.

On Win 10 64-bit and Linux (what I'm able to test) it seems to, but I haven't been able to make sure the button downloads the 32-bit installer on a 32-bit machine. (And couldn't find code for the OS check in the pythondotorg repo.)

It seems to send this HTML with downloads for each OS

<div class="download-for-current-os">
    <div class="download-os-macos" style="display: none;">
        <h1 class="call-to-action">Download the latest version for macOS</h1>
        <p class="download-buttons">
            <a class="button" href="https://www.python.org/ftp/python/3.11.0/python-3.11.0-macos11.pkg">Download Python 3.11.0</a>
        </p>
    </div>
    <div class="download-os-source" style="display: none;">
        <h1 class="call-to-action">Download the latest source release</h1>
        <p class="download-buttons">
            <a class="button" href="https://www.python.org/ftp/python/3.11.0/Python-3.11.0.tar.xz">Download Python 3.11.0</a>
        </p>
    </div>
    <div class="download-os-windows" style="display: none;">
        <h1 class="call-to-action">Download the latest version for Windows</h1>
        <p class="download-buttons">
            <a class="button" href="https://www.python.org/ftp/python/3.11.0/python-3.11.0-amd64.exe">Download Python 3.11.0</a>
        </p>
    </div>
    <div class="download-unknown">
        <h1 class="call-to-action">Download the latest version of Python</h1>
        <p class="download-buttons">
            <a class="button" href="/downloads/release/python-3110/">Download Python 3.11.0</a>
        </p>
    </div>

And then use JS to hide/show the relevant ones.

            $.get("/box/supernav-python-downloads/",
                function(data){
                 $('li#downloads .subnav').append( data );
                    /* Toggle Download buttons by OS detection */
                    if (navigator.appVersion.indexOf("Win")!=-1) {
                        $('.download-unknown').hide();
                        $('.download-os-windows').show();
                    }
                    if (navigator.appVersion.indexOf("Mac")!=-1) {
                        $('.download-unknown').hide();
                        $('.download-os-macos').show();
                    }
                    if (navigator.appVersion.indexOf("X11")!=-1) {
                        $('.download-unknown').hide();
                        $('.download-os-source').show();
                    }
                    if (navigator.appVersion.indexOf("Linux")!=-1) {
                        $('.download-unknown').hide();
                        $('.download-os-source').show();
                    }
                }, "html");

So it seems it doesn't check for 32bit systems and would give the 64bit version either way. I think 32bit should be fairly uncommon now so it shouldn't be a massive problem as long as it's mentioned somewhere.

discretegames · 2022-11-13T18:33:25Z

Thanks for finding that OS check code. Weird they don't check for 32-bit since it is possible. But oh well, I mention to go the the releases page on 32-bit.

…ides

wookie184 · 2022-11-17T18:34:14Z

Will merge into my branch now since we'll need 2 approvals on my PR before merging to main anyway, thanks again!

discretegames added 16 commits November 5, 2022 12:52

Rewrote and added more info to python on ms store article

efa1ef3

added right aligned drake image and a few tweaks to ms store guide

952c4a5

final tweaks to ms store article

13779f3

Redid windows guide titles/slugs/descriptions to be consistent with p…

3668202

…lanned changes and have nice order

Rewrote safe method for adding Python to path, in own article

19caa0a

finished detailed, screenshot full, putting python on path guide

40ad001

Proofread, tweaked, added links to common windows issues guide. (Also…

a7c59dd

… normalized to 120 wide with rewrap vsc ext)

tweaks and link fixes to windows guides, still in reorg process

4d734b0

reorg of windows guides, moved py launcher into installing and using,…

f1961a0

… fixed links

added toc to windows guides

4bb5c57

Finished recommended Python Windows install instructions

54a596e

completed more install info section of Windows guide

3dc24ec

re-added venv section to windows guide

c2fdf87

finished py launcher section, finishing Windows guide reorg

790d076

Added WSL2 section to windows guide; other tweaks

ee5e1ba

Proofread windows guides and added image links everywhere

c7f37e9

discretegames requested a review from wookie184 November 8, 2022 14:16

discretegames marked this pull request as ready for review November 8, 2022 14:23