Diagnostic Tool and Codes Library

February 25, 2021

In order to run the diagnostic tool run:

python -m tools.diagnostic

When running the script you may see 'codes' that should correspond to the solutions below:

S101 - Python is not installed

Windows

Open the Python Website: https://www.python.org
Select Downloads
Look for "Download the latest version for Windows"
Select the button that is "Download Python 3.8.3" (totally ok if the number is greater than 3.8.3! But if you already have a version of Python that is less than 3.8.3 please update to 3.8.3 or higher)
Open the download once it completes and carefully follow the instructions below
1. IMPORTANT Check the box on the first screen labelled "Add Python 3.8 to PATH"
  - Knowing exactly what this does is beyond your concern, but the short story is it makes it easier for other programs (such as your text editor Visual Studio Code) to make use of Python.
2. AFTER ensuring the box of step #1 is checked, click Install Now
3. Allow the installer to make changes if further prompted
4. IMPORTANT On the "Setup was Successful" screen, click on "Disable path length limit". Allow this change when prompted.
  - This is also outside your concern, but it removes a silly, old limitation on how long your project's directory names and file names could be.
5. Click the Close button to complete the Install.

macOS

Open the Python Website: https://www.python.org
Select Downloads
Look for the "Download latest version for Mac OS X"
Select the button that is "Download Python 3.8.3" (totally ok if the number is greater than 3.8.3! But if you already have a version of Python that is less than 3.8.3 please update to 3.8.3 or higher)
Open the downloaded package to begin the installer
1. At Introduction screen: Continue
2. At the Read Me screen: Continue
3. At the License: Continue (Agree)
4. At Installation Type: Install
5. After Install completes, select Close
6. If asked, move the installer to Trash

Alias the python command to refer to the version of Python you just installed:

Use Finder's Spotlight Search feature (Command+Space) to open the Terminal application
Try typing python3 --version and pressing Enter to complete the line. You should see Python 3.8.3 printed out. If you don't after installing Python as above, try rebooting your machine.
Next you'll alias the command python to mean the same as python3. By default on a Mac the command python means version 2 rather than 3. For professional programmers supporting old applications it can be useful to have both version 2 and 3 available. For your purposes, though, you can avoid a lot of frustration by ensuring you're always working with the latest version which is what the next steps will achieve.
1. Look in the title bar of your Terminal window, you should see your computer user name followed by an emdash and then either -zsh or -bash
2. If you see -zsh write the following command in Terminal, being careful to match punctuation exactly:
3. echo "alias python=python3" >> ~/.zprofile
4. After pressing enter this command adds an alias to your .zprofile file which contains settings for how your terminal works. The details of this command are outside the scope of our concerns for the time being.
5. If you see -bash write the following command in Terminal, being careful to match punctuation exactly:
6. echo "alias python=python3" >> ~/.bash_profile
7. After pressing enter this command adds an alias to your .bash_profile file which contains settings for how your terminal works. The details of this command are outside the scope of our concerns for the time being.
8. Close your Terminal window and open a new one for this change to take effect and then try typing:
9. python --version
10. You should see Python 3.8.3 print and not Python 2.7.x. If you are still seeing version 2.0, try the first instruction again and restart your terminal once more.
11. Once this is working, you can close the Terminal.

S102 - python command runs a version less than 3.8

Windows

Open the Python Website: https://www.python.org
Select Downloads
Look for "Download the latest version for Windows"
Select the button that is "Download Python 3.8.3" (totally ok if the number is greater than 3.8.3! But if you already have a version of Python that is less than 3.8.3 please update to 3.8.3 or higher)
Open the download once it completes and carefully follow the instructions below
1. IMPORTANT Check the box on the first screen labelled "Add Python 3.8 to PATH"
  - Knowing exactly what this does is beyond your concern, but the short story is it makes it easier for other programs (such as your text editor Visual Studio Code) to make use of Python.
2. AFTER ensuring the box of step #1 is checked, click Install Now
3. Allow the installer to make changes if further prompted
4. IMPORTANT On the "Setup was Successful" screen, click on "Disable path length limit". Allow this change when prompted.
  - This is also outside your concern, but it removes a silly, old limitation on how long your project's directory names and file names could be.
5. Click the Close button to complete the Install.

macOS

Navigate to https://www.python.org
Follow the set up instuctions here: [/resources/setup/software.html] to make sure Python greater than or equal to 3.8 is installed.

S103 - Python version being run in vscode is lower than 3.8

Open the View menu and Command Palette. Type "Python: Select Interpretter" (without the quotes) and press Enter. From the list that pops up choose Python 3.8.3 or greater.
If you do not see Python 3.8 as an option follow the steps in S103

S201 - Git is not installed.

Windows

Open the Git website: https://git-scm.com
Look for the button to "Download for Windows" (it is embedded in a monitor graphic)
After the download begins open the installer
Allow the app to make changes and install
Press Next on the Information page
Press Next on the Destination Location page (default is fine)
Press Next on the Components page (defaults are fine)
Press Next on the Start Menu Folder page
Choose Visual Studio Code as Git's default editor and press Next
Press Next/Install on the remaining pages and accept the defaults
Follow instructions in S202 and S203 to finish configuring git.

macOS

Open Finder's Spotlight Search (the magnifying glass in your menu bar or press Command+Space)
Search for Terminal and open it
Type git --version and press Enter.
If you see text displayed such as "git version 2.21.0)" then you already have git installed and can close the terminal and continue on
If git was not already installed, you should see a pop-up window asking you to install Git / Developer Tools. Accept that install and follow its instructions through completion.
Follow instructions in S202 and S203 to finish configuring git.

S202 - Git email and username are not configured

Open up a new terminal in vscode
Type git config --global user.email "onyen@live.unc.edu", using your onyen and email.
Type git config --global user.name "Your Name", replacing "Your Name" with your first and last name.

S203 - No upstream exists

Open the View menu and select Command Palette
Type in Git: Add Remote and press enter with the option selected.
Copy and paste the URL below into the text box that says "Provide repository URL" and press enter:
- https://github.com/comp110-20f/course-material.git
When asked for "Remote name" type in:
- upstream
Press enter.
Open the View menu and select Command Palette once more
Type in Git: Fetch From All Remotes and press enter
The upstream remote repository is now registered! In an upcoming lesson you will learn how to download new material from this repository.

S204 - Upstream does not match course upstream

Open up a new terminal in vscode
Type git remote rm upstream and press enter.
Follow instructions in S203 to configure the correct remote.

S301 - Missing VScode Packages

Open up the course workspace
Open up a new terminal
Type python -m pip install pip -r requirements.txt and hit enter.

Contributors:

Ezri '22