Procházet zdrojové kódy

Document new option for bundled Python

Thomas Kluyver před 9 roky
rodič
revize
a77ae026ae
2 změnil soubory, kde provedl 47 přidání a 2 odebrání
  1. 41 2
      doc/cfgfile.rst
  2. 6 0
      doc/releasenotes.rst

+ 41 - 2
doc/cfgfile.rst

@@ -108,8 +108,8 @@ Python section
 
 
 .. describe:: version
 .. describe:: version
 
 
-  The Python version to download and bundle with your application. At present,
-  this needs to be at least ``3.3.0``.
+  The Python version to download and bundle with your application, e.g. ``3.4.3``.
+  Python 3.3 or later and 2.7 are supported.
 
 
 .. describe:: bitness (optional)
 .. describe:: bitness (optional)
 
 
@@ -117,6 +117,45 @@ Python section
   defaults to the version you're using, so that compiled modules will match. On
   defaults to the version you're using, so that compiled modules will match. On
   other platforms, it defaults to 32-bit.
   other platforms, it defaults to 32-bit.
 
 
+.. describe:: format (optional)
+
+  - ``installer`` includes a copy of the Python MSI installer in your application
+    and runs it at install time, setting up Python systemwide. This is the
+    default for now.
+  - ``bundled`` includes an embeddable Python build, which will be installed as
+    part of your application. This is available for Python 3.5 and above.
+
+.. _python_bundled:
+
+Bundled Python
+~~~~~~~~~~~~~~
+
+.. versionadded:: 1.6
+   Experimental support for bundling Python into the application.
+
+Using ``format = bundled``, an embeddable Python build will be downloaded at
+build time and packaged along with the application. When the installer runs, it
+will create a ``Python`` subfolder inside the install directory with the files
+Python needs to run.
+
+This has the advantage of producing smaller installers (~7.5 MB for a trivial
+application), and more standalone installations. But it has a number of
+limitations:
+
+- This option is only available for Python 3.5 and above. These versions of
+  Python have dropped support for Windows XP, so your application will only work
+  on Windows Vista and newer.
+- Installing in Windows Vista to 8.1 (inclusive) may need an internet connection
+  to download the necessary `Visual C++ runtime
+  <http://www.microsoft.com/en-us/download/details.aspx?id=48145>`__. This isn't
+  needed on Windows 10, which includes the necessary files.
+- The embeddable Python builds don't include ``tkinter``, to save space.
+  Applications with a tkinter GUI can't easily use bundled Python. Workarounds
+  may be found in the future.
+- The user cannot easily install extra Python packages in the application's
+  Python. If your application has plugins based on Python packages, this might
+  require extra thought about how and where plugins are installed.
+
 Include section
 Include section
 ---------------
 ---------------
 
 

+ 6 - 0
doc/releasenotes.rst

@@ -1,6 +1,12 @@
 Release notes
 Release notes
 =============
 =============
 
 
+Version 1.6
+-----------
+
+* Experimental support for creating installers that :ref:`bundle Python with the
+  application <python_bundled>`.
+
 Version 1.5
 Version 1.5
 -----------
 -----------