Abstract
+Abstract
cx_Freeze is a set of scripts and modules for freezing Python scripts into executables in much the same way that py2exe and py2app do. Unlike these two tools, cx_Freeze is cross platform and should work on any platform that Python -itself works on. It requires Python 2.3 or higher since it makes use of the +itself works on. It requires Python +2.3 or higher since it makes use of the zip import facility which was introduced in that version.
-cx_Freeze is distributed under an open-source license.
+ +cx_Freeze is distributed under an open-source +license (the 'PSF license').
Using cx_Freeze
+Using cx_Freeze
There are three different ways to use cx_Freeze. The first is to use the included cxfreeze script which works well for simple scripts. The second is to create a distutils setup script which can be used for more complicated @@ -334,8 +78,9 @@ called libr options are necessary when creating an RPM since the RPM builder automatically strips executables. These options are described in greater detail below as well.
+cxfreeze script
+cxfreeze script
The cxfreeze script is included with other Python scripts. On Windows and the Mac this is in the Scripts subdirectory of your Python installation whereas on Unix platforms this in the bin directory of the prefix where Python @@ -446,8 +191,9 @@ will specify the archive name to use; mu
distutils setup script
+distutils setup script
In order to make use of distutils a setup script must be created. This is called setup.py by convention although it need not be called that. A very simple script might use the following:
@@ -473,9 +219,9 @@ provide the ability to both build and in fashion they can be provided in the setup script, on the command line or in a setup.cfg configuration file. They are described in further detail below.distutils commands
+distutils commands
build
+build
This command is a standard command which has been modified by cx_Freeze to build any executables that are defined. The following options were added to the standard set of options for the command:
@@ -497,7 +243,7 @@ the standard set of options for the commbuild_exe
+build_exe
This command performs the work of building an executable or set of executables. It can be further customized:
install
+install
This command is a standard command which has been modified by cx_Freeze to install any executables that are defined. The following options were added to the standard set of options for the command:
@@ -647,8 +394,9 @@ filesinstall_exe
+install_exe
This command performs the work installing an executable or set of executables. It can be used directly but most often is used when building Windows installers or RPM packages. It can be further customized:
@@ -684,8 +432,9 @@ defaults to the build_dir from the buildbdist_msi
+bdist_msi
This command is a standard command in Python 2.5 and higher which has been modified by cx_Freeze to handle installing executables and their dependencies. The following options were added to the standard set of options for the @@ -715,16 +464,18 @@ to the installation of this one
bdist_rpm
+bdist_rpm
This command is a standard command which has been modified by cx_Freeze to ensure that packages are created with the proper architecture for the platform. The standard command assumes that the package should be architecture independent if it cannot find any extension modules.
cx_Freeze.Executable
+cx_Freeze.Executable
The options for the build_exe command are the defaults for any executables that are created. The options for the Executable class allow specification of the values specific to a particular executable. The arguments to the @@ -827,7 +578,8 @@ on what values can be placed here.