zipapp - Manage executable Python zip archives

The zipapp module was introduced in Python 3.5 to manage executable Python zip archives. This module allows you to package Python applications into a single executable .pyz file that can be run directly by the Python interpreter.

Creating a Basic Executable Archive

To create an executable archive, you need a directory containing Python code with a main function. Let's create a simple example ?

First, create a directory called myapp and add an example.py file:

def main():
    print('Hello World')

if __name__ == '__main__':
    main()

Now create the executable archive using the command line ?

python -m zipapp myapp -m "example:main"

This creates myapp.pyz which can be executed directly ?

python myapp.pyz
Hello World

Command Line Options

The zipapp module supports several command line options for customization ?

Output File (-o, --output)

Specify a custom output filename instead of using the default ?

python -m zipapp myapp -o custom_app.pyz

Python Interpreter (-p, --python)

Specify which Python interpreter to use ?

python -m zipapp myapp -p "/usr/bin/python3"

Compression (-c, --compress)

Compress the archive to reduce file size ?

python -m zipapp myapp -c

Programmatic Interface

You can also create archives programmatically using the zipapp module functions ?

Creating Archives

import zipapp
import os

# Create a sample directory structure
os.makedirs('sample_app', exist_ok=True)

# Create a simple main module
with open('sample_app/main.py', 'w') as f:
    f.write('''
def main():
    print("Application started successfully!")
    
if __name__ == "__main__":
    main()
''')

# Create the executable archive
zipapp.create_archive('sample_app', target='sample_app.pyz', main='main:main')
print("Archive created: sample_app.pyz")

Archive created: sample_app.pyz

Getting Interpreter Information

import zipapp

# Get interpreter from an existing archive
try:
    interpreter = zipapp.get_interpreter('sample_app.pyz')
    print(f"Interpreter: {interpreter}")
except FileNotFoundError:
    print("Archive not found")

Interpreter: None

Key Functions

Common Use Cases

Zipapp is particularly useful for:

• Distributing Python applications as single files
• Creating portable Python scripts
• Packaging command-line tools
• Simplifying application deployment

Conclusion

The zipapp module provides a convenient way to package Python applications into executable archives. Use the command line interface for quick packaging or the programmatic interface for automated build processes.