Including Folders with cx_Freeze

When using cx_Freeze to deploy an application, it may be desirable to include an entire directory in the package. While manually including individual files is insufficient to preserve the directory structure, there are methods to accomplish this.

Setting Include Files Argument

Cx_Freeze provides an option to include files from specific directories within the build process. This can be achieved by modifying the buildOptions dictionary. Here are two approaches:

• Single File with Absolute Path:

buildOptions = dict(include_files = [(absolute_path_to_your_file, "final_filename")])

• Folder with Relative Path:

buildOptions = dict(include_files = ["your_folder/"])

Choosing the Right Approach

Using a tuple as in the single file example sets the absolute path for the file. Conversely, using a list as in the folder example provides a relative path. Determine which approach aligns better with the project's requirements.

Additional Resources

For further clarification, refer to the following topic:

• How can I bundle other files when using cx_freeze?