Python Package Compiler

Package MATLAB programs for deployment as Python packages

Since R2025a

Description

The Python Package Compiler packages MATLAB^® programs into Python^® packages that you can integrate into Python applications. The interactive menus and dialog boxes used in the compiler apps build compiler.build commands that are customized to your specification.

Compiler app advantages include:

• You can perform deployment tasks with a single intuitive interface.

• You can organize your files in a MATLAB project.

• Your project state persists between sessions.

• You can load previously stored compiler tasks from a prepopulated menu.

• You can package applications with an installer for distribution.

For more information, see Target-Specific Compiler Apps for MATLAB Code Deployment.

Open the Python Package Compiler App

• MATLAB toolstrip: On the Apps tab, under Application Deployment, click the app icon.

• MATLAB command prompt: Enter pythonPackageCompiler.

Examples

• Create Python Package Using Python Package Compiler App

Parameters

Exported Functions — MATLAB files

Files implementing MATLAB functions. Files must have one of the following extensions: .m, .p, .mlx, or .mexa64.

All files must be located in the project root folder to be added to the project. To add MATLAB functions to the deployable archive., click Add Exported Function and select your MATLAB file. In the Project panel, the file you selected gains the labels Design and Exported Function File.

Package Info

Package Name — Name of package

My Java Package (default)

Name of the generated Java^® package.

Version — Version of installed package

1.0.0 (default)

Version number of the package.

Author Name — Name of author

string

Name of application author.

Email — Email address

string

Email address of the application author.

Company — Company name

string

Name of company that created the application.

Summary — Summary description of package

string

Summary description of the package, specified as a character vector or a string scalar.

Description — Detailed package description

string

Detailed description of the package, specified as a character vector or a string scalar.

Output Locations

Output Folder for the Build — Path to folder where deployable archive is generated

[project root]\<task_name>\output\build (default)

Path to folder where the build artifacts are generated.

Output Folder for the Installer — Path to folder where installer is generated

[project root]\<task_name>\output\package (default)

Path to folder where the installer is generated.

Build Settings

Code Obfuscation — Obfuscate deployable archive

off (default) | on

Obfuscate folder structures, file names, and user code in the deployable archive.

If you enable this property, then folder structures and file names in the deployable archive are obfuscated from the end user, and user code and data contained in .m, .mlapp, .p, .mat, MLX, SFX, and MEX files are placed into a user package within the archive. Additionally, all .m files are converted to P-files before packaging.

During runtime, MATLAB code and data is decrypted and loaded directly from the user package rather than extracted to the file system. MEX files are temporarily extracted from the user package before being loaded.

To manually include additional file types in the user package, add each file type in a separate extension tag to the file matlabroot/toolbox/compiler/advanced_package_supported_files.xml.

The following are not supported:

• ver function

• Calling external libraries such as DLLs

• Out-of-process MATLAB Runtime (C++ shared library for MATLAB Data Array)

• Out-of-process MEX file execution (mexhost, feval, matlab.mex.MexHost)

• Before R2023b: .mat files other than v7.3

Enabling this option is equivalent to using mcc with -j and -s specified.

If you do not enable this property, then the deployable archive is not obfuscated. This is the default behavior.

Files Required for Package to Run

Required Support Packages — Support packages to include

list of support packages

Support packages to include in the deployable archive. The dependency analysis process detects and includes the required support packages automatically. Only the specified support packages are included. To list installed support packages or those used by a specific file, see compiler.codetools.deployableSupportPackages.

Custom Requirements — Additional files and folders to include

list of files

Additional files and folders to include in the deployable archive. To add the contents of a folder, click Add Folder. To add an individual file, click Add File.

Discovered Requirements — Detailed package description

list of files

Additional files to include in the deployable archive. The dependency analysis process detects and includes required data files automatically unless Automatically include data files that are provided as inputs to functions such as load and fopen is disabled.

To view the file analysis results, click View Analysis. To perform the dependency analysis process again, click Reanalyze.

Automatically include data files that are provided as inputs to functions such as load and fopen — Automatically include data files

on (default) | off

Automatically include data files in the deployable archive.

• If you enable this property, then data files that you provide as inputs to certain functions (such as load and fopen) are automatically included in the deployable archive. This is the default option.

• If you disable this property, then you must add data files to the package in the Custom Requirements section.

Samples

Sample Generation — Add sample MATLAB files

button

Generate and modify sample MATLAB files, which are compiled into Python code that demonstrates how to call a MATLAB exported function in the target language.

For each MATLAB sample file you include during packaging, a sample application in the target language is generated in a folder named samples. These samples are also included in the installer.

To upload a MATLAB script you have already written, click Add existing sample.

To generate a new MATLAB sample file, click Create new sample. This opens up a MATLAB script for you to edit. After packaging, the generated sample code calls your exported function using the same arguments as in the sample MATLAB script.

For more information, see Create Sample Code to Call Exported Function.

Installer Details

Package Type — MATLAB Runtime delivery

Fetch MATLAB Runtime from mathworks.com during application installation (default) | Include MATLAB Runtime in application installer for offline installation | Do not include MATLAB Runtime in application installer

MATLAB Runtime delivery option, specified as one of the following.

• Fetch MATLAB Runtime from mathworks.com during application installation — Option for the installer to download MATLAB Runtime from the MathWorks^® website during application installation. This option is the default behavior.

• Include MATLAB Runtime in application installer for offline installation — Option to include MATLAB Runtime within the installer so that it can be installed during application installation without connecting to the MathWorks website. Use this option if you think your end user might not have access to the internet.

• Do not include MATLAB Runtime in application installer — Option to not install MATLAB Runtime during application installation. Use this option if you think your end user will install MATLAB Runtime using another method. (since R2024a)

Note

If you use either the Fetch or Include option, the full MATLAB Runtime will be installed. To create a minimal MATLAB Runtime installer that can run one or more specific MATLAB Runtime applications, see compiler.runtime.customInstaller. (since R2024b)

Installer Name — MATLAB files

MyAppInstaller (default) | string

Name of the generated installer.

Default Install Location — Path to folder where application will be installed

%ProgramFiles%\<application_name> (default)

Path to folder where the application will be installed. The folder is located in the %ProgramFiles% folder of the target machine.

Installer Notes — Notes for installer

string

Notes about additional requirements for using the application.

Splash Screen — Splash screen image

image

Image file used as the installer splash screen, specified as a character vector or a string scalar. The splash screen icon will be resized to 400 pixels by 400 pixels.

Icon — Icon image

image

Image file used as the icon for the installer.

Sidebar Image — Installer image

character vector | string scalar

Image file used as the installer logo, specified as a character vector or a string scalar. The logo will be resized to 112 pixels by 290 pixels.

Version History

Introduced in R2025a

R2025a: Change in app entry point

In R2024b and earlier releases, you can generate Python packages using the Library Compiler. Starting in R2025a, use the Python Package Compiler to create Python packages.

R2025a: Change in output folder name

In R2024b and earlier releases, the compiler apps generate output files in the folders for redistribution, for redistribution_files_only, and for testing. Starting in R2025a, the compiler apps generate output files in a folder named after the compiler task.