PyInstaller-Assistance-Tools--PAT

"...an easier way to compile your python application with PyInstaller..."

###why?### This whole thing came from my struggles with creating an all-in-one-shot method to create a standalone/single application within PyInstaller...ok here goes...link to SO answer I wrote too:

###but there's other compilers in the wild, right?### Might I suggest using PyInstaller instead of py2exe or anything else for that matter since PyInstaller does a far better job in terms of bundling a single executable. I'm on Windows about 90% of the time (no complaints here) with my python coding-- PyInstaller is a way better option than py2exe (for me at least -- I've used/test a great deal of Windows compilers in the past with varied success). Maybe other people suffering from compiling issues could benefit from this method as well.

###PyInstaller Prerequisites:###

1. Install PyInstaller from: http://www.pyinstaller.org/
2. After PyInstaller installation-- confirm both "pyi-makespec.exe" and "pyi-build.exe" are in the "C:\Python##\Scripts" directory on your machine
3. Download my PyInstaller-Assitance-Tools--PAT (it's just 2 batch files and 1 executable with the executable's source python file too -- for the paranoid)...The file are listed above:

• Create_Single_Executable_with_NO_CONSOLE.bat
• Create_Single_Executable_with_CONSOLE.bat
• pyi-fixspec.exe
• pyi-fixpec.py (optional -- this is the source file for the executable -- not needed)

4. Place the exectuable file called "pyi-fixspec.exe" inside the previous "Scripts" folder I mentioned above...this makes compiling much easier in the long run!

###let's get it working now...some slight code changes to your python application###

1. I use a standard function that references the location of applications/scripts that my python application needs to utilize to work while being executed/operated. This function operates both when the app is a standalone python script or when it's fully compiled via pyinstaller.

Here's the piece of code I use:

  def resource_path(relative_path):
      """ Get absolute path to resource, works for dev and for PyInstaller """
      if hasattr(sys, '_MEIPASS'):
          return os.path.join(sys._MEIPASS, relative_path)
      return os.path.join(os.path.abspath("."), relative_path)

and here's my app using it....

  source = resource_path("data\my_archive_file.zip")

that means the app/files look something like this in terms of directory structure:

  C:\Path\To\Application\myscript_001.py               <---    main application/script intended to be compiled
  ...
  C:\Path\To\Application\data\my_archive_file.zip      <---|
  C:\Path\To\Application\data\images\my_picture.jpg    <---|   supporting files in the bundled app
  C:\Path\To\Application\info\other_stuff.json         <---|
  ...

Please note that the data/files/folders I'm bundling for my app are below the main executable/script that I'll be compiling...the "_MEIPASS" part in the function lets pyinstaller know that it's working as a compiled application...VERY IMPORTANT NOTE: Please use the function "resource_path" since the "pyi-fixspec.exe" application will be looking for that phrase/function while parsing/correcting the python application pathing

2. Goto the directory containing the 2 batch files mentioned above and type in either: ####Option #1#### C:\MyComputer\Downloads\PAT> Create_Single_Executable_with_NO_CONSOLE.bat C:\Path\to\the\python\file.py

The output executable file results in a GUI app when double clicked

####Option #2#### C:\MyComputer\Downloads\PAT> Create_Single_Executable_with_CONSOLE.bat C:\Path\to\the\python\file.py

The output executable file results in a WINDOWS CONSOLE app when double clicked -- expects commandline activity ONLY

3. Your new single-file-executable is done! Check for it in this location

   C:\Original\Directory\ApplicationDistribution64bit\NameOfPythonFile\dist

If you do edit/change the original python file that has just been previously compiled, please delete the folder/contents of *\NameOfPythonFile* prior to next compile kickoff (you'll want to delete the historical/artifact files)

4. Coffee break -- or if you wany to edit/add ICONS to the executable (and other items too), please look at the generated ".spec" file and PyInstaller documentation for configuration details. You'll just need to kick off this again in the windows console:

   pyi-build.exe C:\path\to\the\pythonfile.spec

###future stuff???###

• I'll add my "right-click-to-compile" option/application (a windows context menu)
• add a feature within python file to referrence icons (so you don't need to manually edit/touch the .spec file
• I'll be back to tinker with this later.

Enjoy!

-Doug Jr.