Appendix B - Python IDEs.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "*********************************************************************************************************\n",
    "# A Tour of Python 3  \n",
    "version 1.0.1  \n",
    "Authors: Phil Pfeiffer, Zack Bunch, and Feyisayo Oyeniyi  \n",
    "East Tennessee State University  \n",
    "Last updated June 2021  \n",
    "*********************************************************************************************************"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Appendix B. Python IDEs - VS Code, VS 2019, PyDev, PyCharm \n",
    " &ensp; B.1 [Visual Studio Code (VS Code)](#Python-IDEs-visual-studio-code)  \n",
    " &ensp; B.2 [Visual Studio 2019](#Python-IDEs-visual-studio-2019)  \n",
    " &ensp; B.3 [PyDev](#Python-IDEs-PyDev)  \n",
    " &ensp; B.4 [PyCharm](#Python-IDEs-pyCharm)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### B.1 Visual Studio Code (VS Code) <a name = 'Python-IDEs-visual-studio-code'></a>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Visual Studio (VS) Code, according to its [homepage](https://code.visualstudio.com/docs), is ",
    "`a lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux.` ", 
    "VS Code has a [downloadable installer](https://code.visualstudio.com/Download), ",
    "along with a ",
    "[tutorial for installing and using Python with VS Code](https://github.com/Microsoft/vscode-docs/blob/master/docs/python/python-tutorial.md).\n",  
    "\n",
    "The following is a brief 'how to' for this installation:\n",
    "-  Start VS Code.  You should find a link to it in the Windows 10 start menu.\n",
    "-  Select the Extensions icon in the left-hand vertical toolbar.  This should yield a left-hand menu with the legend EXTENSIONS:MARKETPLACE.\n", 
    "-  In the list of extensions that appears, select 'Python (2020.12.424452561) – ",
    "   Linting, Debugging (multi-threaded, remote), Intellisense, Jupyter Notebooks, code formatting, refactoring, unit tests, snippets, and more'\n", 
    "   -  This is the Microsoft-provided extension for Python.  Check for “Microsoft” under the extension’s name.\n", 
    "   -  While other extensions in the Python marketplace may be useful, I haven’t explored any.\n", 
    "-  Selecting this extension should yield a window that prescribes a three step 'Set up your environment' procedure. ",
    "   Seemingly, only the first step is essential.  The directions, moreover, were incomplete and seemed confusing.  The following seems to work:\n",
    "   -  Type control-shift-P\n",
    "   -  In the search window that now appears, Enter 'python'.\n",
    "   -  You should now see 'Python: Select Interpreter'.  Select it.\n",
    "   -  From the menu that appears, select the application that you've installed-- say, Python 3.9.1, 64-bit.\n",
    "   -  You should now see 'Python 3.9.1. 64-bit' on the bottom, purple, status bar.\n",
    "\n",
    "To confirm that your installation succeeded, create a new Python project, as follows:\n",
    "-  Create a folder to hold your code.\n",
    "-  Select File > Open Folder to make that folder the default directory for capturing your code files.\n",
    "-  Select File > New File to open an edit window.\n",
    "-  Enter some code in the main, code window: for example, `print('hello world')`\n",
    "-  Use the File menu to save this code to a file.  Give the file a .py extension.  You should now see “Python 3.9.1. 64-bit” on the bottom, purple, status bar.\n",
    "-  Select Run > Run without Debugging.\n",
    "   -  A Windows Power Shell window should now open below the edit window, in TERMINAL mode.\n",
    "   -  The IDE should now use the selected Python interpreter, Python 3.9.1., to run this program at a command prompt.\n", 
    "\n",
    "If the program you entered was 'hello world', you should now see 'hello world' on your screen, followed by another command prompt."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### B.2 Visual Studio 2019 <a name = 'Python-IDEs-visual-studio-2019'></a>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Microsoft’s Visual Studio (VS) 2019 community is a freeware IDE for Microsoft-supported languages. ",
    "It includes Microsoft support for Python, downloadable as an optional plugin. ",
    "\n",
    "-  If you’ve yet to install VS 2019, ",
    "   [the VS community installation guide](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2019)",
    "   provides detailed directions on how to install.  Here’s the basic process:\n",
    "   -  Download and run [the VS bootstrapper](https://visualstudio.microsoft.com/downloads).  This will install the VS Installer.\n",
    "   -  Run the VS Installer.\n",
    "      -  This will install VS community 2019.\n",
    "      -  As part of this process, you can select Python Development as a package to install.\n",
    "\n",
    "-  If you’ve previously installed VS 2019, if needed, upgrade to the current version of VS, ",
    "   to ensure support for more recent version(s) of Python.  You can upgrade as follows:\n",
    "   -  Start VS 2019.  You should find a link to it in the Windows 10 start menu.\n",
    "   -  From the welcome screen, select “Continue Without Code”, in the screen’s bottom right corner.\n",
    "   -  Under the IDE’s Help menu, select “Check for Updates”.\n",
    "-  If you’re running the current version of Visual Studio 2019 and have not yet installed support for Python,\n",
    "   -  Run the VS Installer.  You should find a link to it in the Windows 10 start menu.\n",
    "   -  Use the Installer to select and download the Python extension.\n",
    "\n",
    "To confirm that your installation succeeded, create a new Python project, as follows:\n",
    "-  Start VS 2019.  You should find a link to it in the Windows 10 start menu.\n",
    "-  From the welcome screen, select 'Create a New Project'\n",
    "-  Scroll down until you see the choice for 'Python application'.  Select it and click 'next'.\n",
    "-  In the 'Create a project' screen, select a directory and a name for your project.  Select 'Create'.\n",
    "-  A 'creating' progress bar should appear, then disappear, followed by the standard VS 2019 IDE.\n",  
    "   -  If you're using a version of Python that's newer than what the current IDE supports, ",
    "      the IDE’s information bar, which appears immediately below the Python toolbar, ",
    "      will display a message like ",
    "      `You’re using Python 3.x.  Some new features might not work as expected until Visual Studio officially supports this version.`\n",
    "-  Enter some code in the main, code window: for example, `print('hello world')`\n",
    "-  Use the File menu to save this code to a file.\n",
    "-  From the Debug menu, select “Start without Debugging”.  If you’ve installed everything correctly, your program should now execute.\n",
    "   -  If you ran the 'hello world' example, you should see a console window with the line 'hello world', ",
    "      atop a second line that reads 'Press any key to continue . . .'\n",
    "\n",
    "Like other IDEs, support for the most current version of Python may lag VS 2019's current release. ",
    "Using Python features that were added after VS 2019's current level of support will trigger Intellisense errors. ",
    "If a code is started that Intellisense thinks is erroneous, the IDE will respond with a message like, ",
    "`One or more files in your project may contain errors. Do you want to launch anyway?`  ",
    "This message can be disabled by selecting Tools > Options > Python > Debugging, then unchecking 'Prompt before running when errors are present'."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### B.3 PyDev <a name = 'Python-IDEs-PyDev'></a>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "PyDev, according to [its homepage](https://www.pydev.org), ",
    "is \"a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.\" ",  
    "PyDev features, according to the site, include Django integration; code completion; type hinting; code analysis; refactoring; ",
    "debugging, including remote debugging; token browsing; unittest integration; code coverage; reference location; and PyLint integration. ",
    "The Eclipse+PyDev combination appears to provide a seriously heavyweight IDE for creating multi-file Python programs and packages, ",
    "including programs that parse arguments from their command lines.\n",
    "\n",
    "If you wish to try PyDev, first install Eclipse, if you’ve not done so. ",
    "The [Eclipse installer](https://www.eclipse.org/downloads/) ",
    "offers a choice from among multiple, custom-configured versions of the Eclipse IDE.  ",
    "While none support PyDev directly and various websites indicate that any IDE will do, several suggest the Java IDE as a good choice.\n",
    "\n",
    "The [PyDev installation webpage](https://www.pydev.org/manual_101_install.html) ",
    "provides detailed instructions on different ways to install PyDev. ",
    "The directions below use a copy of PyDev downloaded from the Eclipse Marketplace. ",
    "The Marketplace can be accessed from the Eclipse IDE Help menu or from Eclipse’s Welcome screen. ",
    "Opening the Marketplace menu and searching for PyDev produces with an 'Install' option. ",
    "When this is selected, the pop-up gives way to a second PopUp that asks for confirmation.  ",
    "After installation is confirmed, a third pop-up requests users to review and accept the Eclipse Public Licenses.  ",
    "A final pop-up then requests permission to restart the Eclipse IDE to apply the update.\n",
    "\n",
    "To confirm that your installation succeeded, create a Python 'hello world' project, as follows:\n",
    "-  Start Eclipse.\n",
    "-  If the 'Welcome' window appears, do the following to open the IDE:\n",
    "   -  Select the 'Create a new Java project' option from the Welcome window\n",
    "   -  Close the 'Create a Java project' window, without creating a project\n",
    "-  Confirm that PyDev is installed by selecting Window > Preferences and checking for a PyDev menu.\n",
    "-  Confirm that you’re using your platform’s Python interpreter selecting Windows > Preferences >PyDev > Interpreters > Python.\n",
    "   If Eclipse set your interpreter to an interpreter in the C:\\Users directory, \n",
    "   consider changing this to your platform’s default interpreter, which will most likely be in C:\\Program Files\\Python39.\n",
    "-  Select Window > Show View > PyDev Package Explorer.\n",
    "   -  'Window' is Eclipse’s menu bar title for what most Windows applications refer to as 'View'.  ",
    "      If you can’t determine how to reopen a window on, say, an active project that you’ve closed, look under 'View' for options.\n",
    "-  Create a new Python project.\n",
    "   -  Select File > New > PyDev Project\n",
    "   -  In the 'PyDev Project' menu\n",
    "      -  Name the project\n",
    "      -  Accept 'use default' for project contents\n",
    "      -  Set a directory for the project\n",
    "      -  Specify 'Python' as the project type\n",
    "      -  Set grammar version to the most recent supported version of Python - as of this writing, 3.8\n",
    "      -  Configure the Python interpreter as first in PATH\n",
    "      -  Add the project directory to PYTHONPATH\n",
    "      -  Select 'Finish'\n",
    "      -  Accept the invitation to open the “Python perspective”.  This raises a window with the project shown on the left-hand side.\n",
    "-  Create a source folder for this project.\n",
    "   -  Select File > New > Source Folder\n",
    "   -  In the pop-up window that appears, name the folder.\n",
    "-  Create a package for this project.\n",
    "   -  Select File > New > PyDev Package\n",
    "   -  In the pop-up window that appears, name the package.\n",
    "      -  PyDev disallows package names with spaces.\n",
    "-  Create a module—i.e., a code file—for this project.\n",
    "   -  Select File > New > PyDev Module\n",
    "   -  In the pop-up window that appears, name the module\n",
    "   -  Select the “Module: CLI (Argparse)” option\n",
    "-  Populate this file with statement that prints “hello world”.\n",
    "   -  Delete the several hundred lines of code that PyDev added to this file as starter code.\n",
    "   -  Insert the following into this file: `print(“hello world”)`\n",
    "-  Run the program\n",
    "   -  Select Run> Run\n",
    "\n",
    "Eclipse should now open a console window, displaying 'hello world'. ",
    "(*Yes, all of this seems to be needed to get PyDev to print 'hello world'.*)\n",
    "\n",
    "After trying PyDev, if you wish to uninstall Eclipse, you must do so manually. ",
    "Right-clicking on Eclipse and selecting 'uninstall' merely shows that the Windows Add/Remove menu is devoid of any reference to Eclipse. ",
    "Rather, do this:\n", 
    "-  First, remove the .eclipse and eclipse folders from the folder where Eclipse was originally installed. ",
    " In Windows 10, you can (re)discover that directory by\n",
    "   -  Locating Eclipse in your Start menu\n",
    "   -  Right-clicking on the icon for the .exe\n",
    "   -  Selecting More > Open file location\n",
    "-  Then. click on Eclipse in the Start menu.  \n",
    "   -  This should raise a Windows pop-up that states that the executable was not found and that offers to remove the shortcut.\n",
    "   -  Accept the offer."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### B.4 PyCharm <a name='Python-IDEs-pyCharm'></a>"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "JetBrains’ PyCharm IDE, according to its [homepage]( https://www.jetbrains.com/pycharm/), ",
    "'knows everything about your code'. ",
    "PyCharm provides 'intelligent code completion, on-the-fly error checking and quick-fixes, [and] easy project navigation' among other features. ",
    "[The free community version of PyCharm](https://www.jetbrains.com/pycharm/download/download-thanks.html?platform=windows&code=PCC) ",
    "includes an installer.  After running the installer, reboot your computer to finish the installation.\n",
    "\n",
    "To confirm that your installation is working properly, create a new Python project, as follows:\n",
    "-  Start PyCharm.\n",
    "-  Ask to create a project. \n",
    "    - If you wish to save the project to a directory other than the PyCharm default directory, do so.\n",
    "      - Otherwise, stay with the defaults.\n",
    "    - Select main.py as the target code file.\n",
    "-  Follow the instructions in main.py to run the program.  Doing so should produce a 'Run' window with the message 'Hi, PyCharm'.\n",
    "\n",
    "While PyCharm seemed easier to use than PyDev, as part of its installation, PyCharm updates Windows environment variables, ",
    "adding a reference to a directory of its devising to a user’s PATH variable.  ",
    "After adding PyCharm, attempting to execute pip from a command prompt yielded the following error message:\n",
    "\n",
    " &ensp;&ensp; '",
    "`Fatal error in launcher: Unable to create process using '\"c:\\program files\\python 3.9\\python.exe\" \"C:\\Program Files\\Python 3.9\\Scripts\\pip.EXE\" '`\n",
    "\n",
    "Further experimentation showed that `pip` could be launched from the directory that PyCharm had created, but not from C:\\Program Files. ",
    "After subsequent attempts to adjust environment variables failed to fix the issue, ",
    "'normal' operation was restored by uninstalling PyCharm, then uninstalling and reinstalling Python."
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.2"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}