aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/deployment.rst
diff options
context:
space:
mode:
Diffstat (limited to 'sources/pyside2/doc/deployment.rst')
-rw-r--r--sources/pyside2/doc/deployment.rst84
1 files changed, 60 insertions, 24 deletions
diff --git a/sources/pyside2/doc/deployment.rst b/sources/pyside2/doc/deployment.rst
index c81e85c61..f33e3cac0 100644
--- a/sources/pyside2/doc/deployment.rst
+++ b/sources/pyside2/doc/deployment.rst
@@ -1,5 +1,5 @@
-Deployment
-##########
+|project| Deployment
+====================
Deploying or freezing an application is a crucial part of many Python projects.
Most large projects are not based on a single Python file, so
@@ -10,23 +10,18 @@ Here are a few distribution options that you could use:
2. Building a proper `Python package (wheel) <https://packaging.python.org/>`_.
3. Freezing the application into a single binary file or a directory.
-.. _fbs: https://build-system.fman.io/
-
-.. _pyinstaller: https://www.pyinstaller.org/
-
-.. _cxfreeze: https://anthony-tuininga.github.io/cx_Freeze/
-
-.. _py2exe: http://www.py2exe.org/
-
-.. _py2app: https://py2app.readthedocs.io/en/latest/
-
If you choose the **third** option, consider using one of these tools:
* `fbs`_
- * `PyInstaller <pyinstaller>`_
- * `cx_Freeze <cxfreeze>`_
+ * `PyInstaller`_
+ * `cx_Freeze`_
* `py2exe`_
* `py2app`_
+.. _fbs: https://build-system.fman.io/
+.. _PyInstaller: https://www.pyinstaller.org/
+.. _cx_Freeze: https://anthony-tuininga.github.io/cx_Freeze/
+.. _py2exe: http://www.py2exe.org/
+.. _py2app: https://py2app.readthedocs.io/en/latest/
|project| is a cross-platform framework,
so we would like to focus on solutions that work on the three
@@ -34,15 +29,56 @@ major platforms supported by Qt: Linux, macOS, and Windows.
The following table summarizes the platform support for those packaging
tools:
-=========== ======= ===== ===== =======
-Name License Linux macOS Windows
-=========== ======= ===== ===== =======
-fbs GPL yes yes yes
-PyInstaller GPL yes yes yes
-cx_Freeze MIT yes yes yes
-py2exe MIT no no yes
-py2app MIT no yes no
-=========== ======= ===== ===== =======
+.. raw:: html
+
+ <table class="docutils align-default">
+ <thead>
+ <tr>
+ <th class="head">Name</th>
+ <th class="head">License</th>
+ <th class="head">Linux</th>
+ <th class="head">macOS</th>
+ <th class="head">Windows</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><p>fbs</p></td>
+ <td><p>GPL</p></td>
+ <td><p style="color: green;">yes</p></td>
+ <td><p style="color: green;">yes</p></td>
+ <td><p style="color: green;">yes</p></td>
+ </tr>
+ <tr>
+ <td><p>PyInstaller</p></td>
+ <td><p>GPL</p></td>
+ <td><p style="color: green;">yes</p></td>
+ <td><p style="color: green;">yes</p></td>
+ <td><p style="color: green;">yes</p></td>
+ </tr>
+ <tr>
+ <td><p>cx_Freeze</p></td>
+ <td><p>MIT</p></td>
+ <td><p style="color: green;">yes</p></td>
+ <td><p style="color: green;">yes</p></td>
+ <td><p style="color: green;">yes</p></td>
+ </tr>
+ <tr>
+ <td><p>py2exe</p></td>
+ <td><p>MIT</p></td>
+ <td><p style="color: red;">no</p></td>
+ <td><p style="color: red;">no</p></td>
+ <td><p style="color: green;">yes</p></td>
+ </tr>
+ <tr>
+ <td><p>py2app</p></td>
+ <td><p>MIT</p></td>
+ <td><p style="color: red;">no</p></td>
+ <td><p style="color: green;">yes</p></td>
+ <td><p style="color: red;">no</p></td>
+ </tr>
+ </tbody>
+ </table>
According to this table, only *fbs*, *cx_Freeze*, and *PyInstaller*
meets our cross-platform requirement.
@@ -57,7 +93,7 @@ to update your application packages.
To create update packages, use the `PyUpdater <https://www.pyupdater.org/>`_,
which is built around PyInstaller.
-The `fbs <https://build-system.fman.io>`_ tool offers a nice UI
+The `fbs`_ tool offers a nice UI
that allows the user to install the application step-by-step.
Here you can find a set of tutorials on how to use the previously