Bladeren bron

Update docs for dropping format='installer'

Thomas Kluyver 7 jaren geleden
bovenliggende
commit
821e283d1d
3 gewijzigde bestanden met toevoegingen van 21 en 47 verwijderingen
  1. 1 1
      README.rst
  2. 10 46
      doc/cfgfile.rst
  3. 10 0
      doc/releasenotes.rst

+ 1 - 1
README.rst

@@ -25,7 +25,7 @@ Quickstart
        icon=myapp.ico
        icon=myapp.ico
 
 
        [Python]
        [Python]
-       version=3.4.0
+       version=3.6.3
 
 
        [Include]
        [Include]
        # Importable packages that your application requires, one per line
        # Importable packages that your application requires, one per line

+ 10 - 46
doc/cfgfile.rst

@@ -39,7 +39,7 @@ Application section
 
 
    Ensure that this boilerplate code is at the top of your script::
    Ensure that this boilerplate code is at the top of your script::
 
 
-       #!python3.3
+       #!python3.6
        import sys
        import sys
        sys.path.insert(0, 'pkgs')
        sys.path.insert(0, 'pkgs')
 
 
@@ -146,8 +146,9 @@ Python section
 
 
 .. describe:: version
 .. describe:: version
 
 
-  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.
+  The Python version to download and bundle with your application, e.g. ``3.6.3``.
+  Python 3.5 or later are supported. For older versions of Python, use Pynsist
+  1.x.
 
 
 .. describe:: bitness (optional)
 .. describe:: bitness (optional)
 
 
@@ -155,22 +156,9 @@ 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 Python up to 3.5.
-  - ``bundled`` includes an embeddable Python build, which will be installed as
-    part of your application. This is available for Python 3.5 and above, and is
-    the default for Python 3.6 and above.
-
-  .. versionchanged:: 1.9
-
-     The default switched to ``bundled`` for Python 3.6 and above.
-
 .. describe:: include_msvcrt (optional)
 .. describe:: include_msvcrt (optional)
 
 
-  This option is only relevant with ``format = bundled``. The default is ``true``,
+  The default is ``true``,
   which will include an app-local copy of the Microsoft Visual C++ Runtime,
   which will include an app-local copy of the Microsoft Visual C++ Runtime,
   required for Python to run. The installer will only install this if it doesn't
   required for Python to run. The installer will only install this if it doesn't
   detect a system installation of the runtime.
   detect a system installation of the runtime.
@@ -187,35 +175,11 @@ Python section
 
 
   .. versionadded:: 1.9
   .. versionadded:: 1.9
 
 
-.. _python_bundled:
-
-Bundled Python
-~~~~~~~~~~~~~~
-
-.. versionadded:: 1.6
-   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, quicker 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 install an app-local copy
-  of the Visual C++ runtime (see above). 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.
+.. note::
+
+   Pynsist 1.x also included a ``format=`` option to select between two ways to
+   use Python: *bundled* or *installer*. Pynsist 2 only supports *bundled*
+   Python. For the installer option, use Pynsist 1.x.
 
 
 .. _cfg_include:
 .. _cfg_include:
 
 

+ 10 - 0
doc/releasenotes.rst

@@ -1,6 +1,16 @@
 Release notes
 Release notes
 =============
 =============
 
 
+Version 2.0
+-----------
+
+Pynsist 2 only supports 'bundled' Python, and therefore only Python 3.5 and
+above. For 'installer' format Python and older Python versions, use Pynsist 1.x
+(``pip install pynsist<2``).
+
+* Pynsist installers can now install into a per-user directory, allowing them
+  to be used without admin access.
+
 Version 1.12
 Version 1.12
 ------------
 ------------