py2exe - generate single executable file

Question

I thought I heard that py2exe was able to do this, but I never figured it out. Has anyone successfully done this? Can I see your setup.py file, and what command line options you used?

Basically I'm thinking of it giving me a single executable file that does something like unzips itself to maybe /temp and runs.

Solution 1

PyInstaller will create a single .exe file with no dependencies; use the --onefile option. It does this by packing all the needed shared libs into the executable, and unpacking them before it runs, just as you describe (EDIT: py2exe also has this feature, see minty's answer)

I use the version of PyInstaller from svn, since the latest release (1.3) is somewhat outdated. It's been working really well for an app which depends on PyQt, PyQwt, numpy, scipy and a few more.

Solution 2

The way to do this using py2exe is to use the bundle_files option in your setup.py file. For a single file you will want to set bundle_files to 1, compressed to True, and set the zipfile option to None. That way it creates one compressed file for easy distribution.

Here is a more complete description of the bundle_file option quoted directly from the py2exe site*

Using "bundle_files" and "zipfile"

An easier (and better) way to create single-file executables is to set bundle_files to 1 or 2, and to set zipfile to None. This approach does not require extracting files to a temporary location, which provides much faster program startup.

Valid values for bundle_files are:

• 3 (default) don't bundle
• 2 bundle everything but the Python interpreter
• 1 bundle everything, including the Python interpreter

If zipfile is set to None, the files will be bundle within the executable instead of library.zip.

Here is a sample setup.py:

from distutils.core import setup
import py2exe, sys, os

sys.argv.append('py2exe')

setup(
    options = {'py2exe': {'bundle_files': 1, 'compressed': True}},
    windows = [{'script': "single.py"}],
    zipfile = None,
)

Solution 3

As the other poster mention, py2exe, will generate an executable + some libraries to load. You can also have some data to add to your program.

Next step is to use an installer, to package all this into one easy-to-use installable/unistallable program.

I have used InnoSetup with delight for several years and for commercial programs, so I heartily recommend it.

Solution 4

I've been able to create a single exe file with all resources embeded into the exe. I'm building on windows. so that will explain some of the os.system calls i'm using.

First I tried converting all my images into bitmats and then all my data files into text strings. but this caused the final exe to be very very large.

After googleing for a week i figured out how to alter py2exe script to meet my needs.

here is the patch link on sourceforge i submitted, please post comments so we can get it included in the next distribution.

http://sourceforge.net/tracker/index.php?func=detail&aid=3334760&group_id=15583&atid=315583

this explanes all the changes made, i've simply added a new option to the setup line. here is my setup.py.

i'll try to comment it as best I can. Please know that my setup.py is complex do to the fact that i'm access the images by filename. so I must store a list to keep track of them.

this is from a want-to-b screen saver I was trying to make.

I use exec to generate my setup at run time, its easyer to cut and paste like that.

exec "setup(console=[{'script': 'launcher.py', 'icon_resources': [(0, 'ICON.ico')],\
      'file_resources': [%s], 'other_resources': [(u'INDEX', 1, resource_string[:-1])]}],\
      options={'py2exe': py2exe_options},\
      zipfile = None )" % (bitmap_string[:-1])

breakdown

script = py script i want to turn to an exe

icon_resources = the icon for the exe

file_resources = files I want to embed into the exe

other_resources = a string to embed into the exe, in this case a file list.

options = py2exe options for creating everything into one exe file

bitmap_strings = a list of files to include

Please note that file_resources is not a valid option untill you edit your py2exe.py file as described in the link above.

first time i've tried to post code on this site, if I get it wrong don't flame me.

from distutils.core import setup
import py2exe #@UnusedImport
import os

#delete the old build drive
os.system("rmdir /s /q dist")

#setup my option for single file output
py2exe_options = dict( ascii=True,  # Exclude encodings
                       excludes=['_ssl',  # Exclude _ssl
                                 'pyreadline', 'difflib', 'doctest', 'locale',
                                 'optparse', 'pickle', 'calendar', 'pbd', 'unittest', 'inspect'],  # Exclude standard library
                       dll_excludes=['msvcr71.dll', 'w9xpopen.exe',
                                     'API-MS-Win-Core-LocalRegistry-L1-1-0.dll',
                                     'API-MS-Win-Core-ProcessThreads-L1-1-0.dll',
                                     'API-MS-Win-Security-Base-L1-1-0.dll',
                                     'KERNELBASE.dll',
                                     'POWRPROF.dll',
                                     ],
                       #compressed=None,  # Compress library.zip
                       bundle_files = 1,
                       optimize = 2                        
                       )

#storage for the images
bitmap_string = '' 
resource_string = ''
index = 0

print "compile image list"                          

for image_name in os.listdir('images/'):
    if image_name.endswith('.jpg'):
        bitmap_string += "( " + str(index+1) + "," + "'" + 'images/' + image_name + "'),"
        resource_string += image_name + " "
        index += 1

print "Starting build\n"

exec "setup(console=[{'script': 'launcher.py', 'icon_resources': [(0, 'ICON.ico')],\
      'file_resources': [%s], 'other_resources': [(u'INDEX', 1, resource_string[:-1])]}],\
      options={'py2exe': py2exe_options},\
      zipfile = None )" % (bitmap_string[:-1])

print "Removing Trash"
os.system("rmdir /s /q build")
os.system("del /q *.pyc")
print "Build Complete"

ok, thats it for the setup.py now the magic needed access the images. I developed this app without py2exe in mind then added it later. so you'll see access for both situations. if the image folder can't be found it tries to pull the images from the exe resources. the code will explain it. this is part of my sprite class and it uses a directx. but you can use any api you want or just access the raw data. doesn't matter.

def init(self):
    frame = self.env.frame
    use_resource_builtin = True
    if os.path.isdir(SPRITES_FOLDER):
        use_resource_builtin = False
    else:
        image_list = LoadResource(0, u'INDEX', 1).split(' ')

    for (model, file) in SPRITES.items():
        texture = POINTER(IDirect3DTexture9)()
        if use_resource_builtin: 
            data = LoadResource(0, win32con.RT_RCDATA, image_list.index(file)+1) #windll.kernel32.FindResourceW(hmod,typersc,idrsc)               
            d3dxdll.D3DXCreateTextureFromFileInMemory(frame.device,   #Pointer to an IDirect3DDevice9 interface
                                              data,                #Pointer to the file in memory
                                              len(data),           #Size of the file in memory
                                              byref(texture))      #ppTexture
        else:
            d3dxdll.D3DXCreateTextureFromFileA(frame.device, #@UndefinedVariable
                                               SPRITES_FOLDER + file,
                                               byref(texture))            
        self.model_sprites[model] = texture
    #else:
    #    raise Exception("'sprites' folder is not present!")

Any questions fell free to ask.

Solution 5

You should create an installer, as mentioned before. Even though it is also possible to let py2exe bundle everything into a single executable, by setting bundle_files option to 1 and the zipfile keyword argument to None, I don't recommend this for PyGTK applications.

That's because of GTK+ tries to load its data files (locals, themes, etc.) from the directory it was loaded from. So you have to make sure that the directory of your executable contains also the libraries used by GTK+ and the directories lib, share and etc from your installation of GTK+. Otherwise you will get problems running your application on a machine where GTK+ is not installed system-wide.

For more details read my guide to py2exe for PyGTK applications. It also explains how to bundle everything, but GTK+.

View more solutions

Comments

[gbjbaanb]

I found py2exe worked a lot better than pyInstaller, when you're using eggs. minty's answer is the solution.

[gbjbaanb]

is it possible to create a single file, that depends on the python dll? I don't mind 1 exe+1 dll (as the dll can be installed to a common location), as long as all the little dependency files are hidden away in the exe.

[minty]

Sure if you want only the interpreter not bundled then choose 2 for the bundle_files option. Good luck!

[Joril]

Please note that bundle_files 1 isn't supported on amd64 (py2exe 0.6.9 for Python 2.6 at least)

[Joril]

Please note that as of version 1.4, PyInstaller doesn't support Python 2.6+ on Windows

[joaquin]

+1 for indicating that after py2exe still there are things to package.

[oob]

I am now using version 1.5.1, and it works with Python 2.7.2.

[Joril]

@endolith: Sorry but I don't remember anymore... :(

[Pat]

What's with the sys.argv.append('py2exe') line? I didn't need that for it to work.

[orlade]

@Pat: The call to run py2exe is "python setup.py py2exe". By automatically appending the "py2exe" on the end, it just means you don't have to type it in at the command line.

[Kevin Smyth]

Not exactly a single executable, as you need to install the Microsoft Visual C runtime DLL.

[joaquin]

As far as I can understand bbfreeze does not produce single-file executables. Could you document your answer ?

[trevorKirkby]

py2exe can create a single file executable if you specify a few arguments in the compiler program. py2exe has a tutorial for single file executables online.

[trevorKirkby]

This is not accurate. With the correct options, you can get one standalone file.

[Jeff B]

I had a console application that I wanted to have as a single executable. I had to replace windows = [{'script': "single.py"}] with console = ['single.py'] so double-clicking the file would open in a CMD window in Windows.

[the_prole]

@minty How does the set-up file know what file directory the resources to bundle are in? How does it know which files they are? Thanks.

[Jonathan Komar]

Objective Viewpoint: I do not see how this is an acceptable answer since it does not address the question of creating a single exe file with py2exe. (Nonetheless, this is a useful answer of course.)

[VinceLomba]

I 've tried your method and it works good but I don' t understeand how to add file to the option file_resurces to embled some file into the .exe. I' ve modified the build_exe.py file as you said but when I go into the setup.py file and I write \'file_resources': [('txt2.txt')] it gives me error (the file that I want to embled in my .exe is named txt2 and it's a .txt file)

[Admin]

This doesn't bundle Tcl

[lightsong]

6 years since @Joril's comment and still - "error: bundle-files 1 not yet supported on win64"

[Jithin Pavithran]

PyInstaller is very bad at adding extra data files in the bundle. It's trying luck! I never got it working. But PyInstaller works perfect if you don't need a single executable file, but a folder is acceptable.

[ZF007]

@Torsten Marek... the link to your setup.py is dead. In particular.. the first two rederects end-up promoting commercial stuff. The third time it ends here at the dead-end of the internet.

[Firix]

@AlexJolig That is probably because you aren't using a compatible version of python. See this post here

[Armster]

cx_Freeze can't create a standalone executable, in fact, the documentation for cx_Freeze at buildmedia.readthedocs.org/media/pdf/cx-freeze/latest/… says, "cx_Freeze does not support building a single file exe, where all of the libraries for your application are embedded in one executable file." For more details on standalone executables in cx_Freeze go to the documentation (buildmedia.readthedocs.org/media/pdf/cx-freeze/latest/…) and go to section 4.5.

[Armster]

You talked about how you converted all your images into bitmats and then all your data files into text strings. Even though you said that it makes the exe large, does this work and if so, can you tell me how to do this? I know this answer is pretty old but if you can respond that will be appreciated.

[Everett Wenzel]

This works wonderful w/ the console options for setup. I am able to retain original console interaction. console=['scriptypoo.py'], thank you!

[DarkLight]

As mentioned above (@JonathanKomar) this does not answer the question directly. note: working with environment separation (like venv) might cause PyInstaller to miss packages. one should use the --paths= switch to avoid that

[Apostolos]

In my case (Python 2.7, Windows 10), this solution creates a huuuuge 4MB EXE file from just a 18KB PY file, and the worst: running the EXE file does absolutely nothing!

[Guimoute]

@JithinPavithran I have no problem bundling data files and resources in my single executable file using PyInstaller, but it imports too many unused modules which causes an huge exe size (300 MB with my distribution). That's what brought me here actually, looking for alternatives to PyInstaller.