Knowledge Base

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Bundling a Multiple Module Python Project Into a Zip File ======

A Python project with multiple modules can be bundled into a single .zip file for easy deployment, similar to a [[https://en.wikipedia.org/wiki/JAR_(file_format)|JAR file]].  This doesn't manage dependencies (like [[https://wiki.python.org/moin/Freeze|Freeze]] or [[https://www.py2exe.org/|py2exe]]) but for systems where you know that the project dependencies (and a Python interpreter) are already installed, it makes using the project much easier.

<WRAP center round info 60%>
This assumes a Linux environment.  It can easily be adapted to Windows, though.
</WRAP>

Here's a simple example.  Let's say you have a Python project with two modules: **%%__main__.py%%**((For the .zip bundle to work, the entry point must be in a file named **%%__main__.py%%**)) and **mygreeting.py**.

<file python main.py>
import mygreeting
import sys

arg_count = len(sys.argv)

print('Number of arguments:', arg_count, 'argument(s).')
print('Argument List:', str(sys.argv))

greeter = mygreeting.MyGreeter()

greeter.say_hello("" if arg_count == 1 else sys.argv[1])
</file>

<file python mygreeting.py>
class MyGreeter:
	def __init__(self) -> None:
		pass

	def say_hello(self, name = ""):
		print("Hello there!" if name == "" else f"Hello, {name}!")
</file>

Compress all of the source files into a .zip file:

<code bash>
zip myapp.zip *.py
</code>

Then, execute the bundle with the Python interpreter:

<code bash>
python3 myapp.zip
</code>

Output:

<code>
Number of arguments: 1 argument(s).
Argument List: ['myapp.zip']
Hello there!
</code>

You can also pass arguments to the bundle:

<code bash>
python3 myapp.zip Jim
</code>

Output:

<code>
Number of arguments: 2 argument(s).
Argument List: ['myapp.zip', 'Jim']
Hello, Jim!
</code>

You can also make a bundle that can be run directly:

<code bash>
echo '#!/usr/bin/env python3' | cat - myapp.zip > myapp

chmod u+x myapp
</code>

Run it:

<code bash>
./myapp
</code>

Same output:

<code>
Number of arguments: 1 argument(s).
Argument List: ['myapp.zip']
Hello there!
</code>

You can copy the .zip or executable bundle anywhere on your system as a single file, and it will be runnable.  Very handy!

{{tag>python}}