1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
=====================
|project| & cx_Freeze
=====================
`cx_Freeze <https://anthony-tuininga.github.io/cx_Freeze/>`_ allows you to freeze your Python
application into executables.
The supported platforms are Linux, macOS, Windows, FreeBSD, among others.
You can read the `official documentation <https://cx-freeze.readthedocs.io/en/latest/index.html>`_
to clarify any further question, and remember to contribute to
the project by `filing issues <https://sourceforge.net/projects/cx-freeze/>`_
if you find any, or contributing to `their development <https://bitbucket.org/anthony_tuininga/cx_freeze/src>`_.
Preparation
===========
Installing `cx_Freeze` can be done via **pip**::
pip install cx_freeze
If you are using a virtual environment, remember to activate it before
installing `cx_Freeze` into it.
After the installation, you will have the `cxfreeze` binary to deploy
your application.
Freezing an application
=======================
There are three options to work with `cx_Freeze`:
1. Using the `cxfreeze` script.
2. Creating `setup.py` script to build the project.
3. Using the module classes directly (for advanced purposes).
We will cover the first two uses cases.
Creating an example
-------------------
Now, consider the following simple script, named `hello.py`::
import sys
import random
from PySide2.QtWidgets import (QApplication, QLabel, QPushButton,
QVBoxLayout, QWidget)
from PySide2.QtCore import Slot, Qt
class MyWidget(QWidget):
def __init__(self):
QWidget.__init__(self)
self.hello = ["Hallo Welt", "你好，世界", "Hei maailma",
"Hola Mundo", "Привет мир"]
self.button = QPushButton("Click me!")
self.text = QLabel("Hello World")
self.text.setAlignment(Qt.AlignCenter)
self.layout = QVBoxLayout()
self.layout.addWidget(self.text)
self.layout.addWidget(self.button)
self.setLayout(self.layout)
# Connecting the signal
self.button.clicked.connect(self.magic)
@Slot()
def magic(self):
self.text.setText(random.choice(self.hello))
if __name__ == "__main__":
app = QApplication(sys.argv)
widget = MyWidget()
widget.resize(800, 600)
widget.show()
sys.exit(app.exec_())
Using `cxfreeze` executable
---------------------------
The command line to proceed will look like this::
cxfreeze hello.py
This command will create a `dist/` directory that will contain the
executable and a `lib/` directory including all the shared libraries.
To launch the application, you need to just go to the `dist/` directory
and execute the file::
cd dist/
./main
Using a setuptools script
-------------------------
For this process, you will need an additional script called `setup.py`::
import sys
from cx_Freeze import setup, Executable
setup(name = "MyApp",
version = "0.1",
description = "My GUI App",
executables = [Executable("hello.py")])
After that, you need to build the project using it::
python setup.py build
This step will create a `build/` directory with the following structure::
build
└── exe.linux-x86_64-3.7
└── lib
└── main
The first directory inside `build/` will depend on the platform
you are using, in this case a `x86_64` Linux using Python 3.7.
The structure is the same as previously described, and you can simply
enter the directory and execute the file::
cd build/exe.linux-x86_64-3.7
./main
|
