Web Analytics Made Easy - Statcounter
Skip to content

Quick Start - Basic Install & Introduction to the APIs

Either you've just finished reading the details of who PySimpleGUI is for, what it can do, why it was made, and are finally ready for how can I get my application written. Or you skipped the who, what, why and are more then ready for the "how to".

More detailed installation and troubleshooting instructions are in the main installing PySimpleGUI section. Installing PySimpleGUI


PySimpleGUI is installed using Python's pip command from the command line. From the command line you'll run pip. For IDEs and virtual environments, the pip may be run for you when you indicate PySimpleGUI is a package to include in your project.

On Windows python is used to run Python:

python -m pip install PySimpleGUI

For Linux & Mac (or any system where you launch Python using the command python3:

python3 -m pip install PySimpleGUI

There are a number of ways of making PySimpleGUI available to your application. The basic goal is to get this statement to run without errors:

import PySimpleGUI as sg

PyPI - The Official Distribution Hub for PySimpleGUI

Using pip to install PySimpleGUI is the recommended method of installing. PyPI is the official repository used to distribute PySimpleGUI. By default, this is where Python's pip command will retrieve PySimpleGUI.

pip Installs Several Command-Line Commands

When you use pip to install PySimpleGUI you're given some commands that you can run via the command line that will invoke PySimpleGUI's built-in utilities. These commands are detailed in the "Utilities" second of this document. They include:

  • psgissue
  • psgmain
  • psghome
  • psgupgrade
  • psghelp
  • psgver
  • psgsettings

The location of these commands depends on your OS, where you installed Python, etc. The path to these commands is added to your environment variables when Python is installed. On Windows, for example, these commands are located in a folder named Scripts in the folder where your python interpreter is located. You should have this folder in your PATH environment variable.