Pup

-------------------------

Enhancements
^^^^^^^^^^^^

- The Windows MSI installer UI now includes auto-generated bitmaps
displaying the packaged application icon. (`103 <https://github.com/mu-editor/pup/issues/103>`_)
- The Windows MSI installation process
can now launch the installed program when done.
Limitation:
only works if a license is included to be displayed and accepted,
which serves the near-term use case for Mu Editor. (`145 <https://github.com/mu-editor/pup/issues/145>`_)
- Documented how to attain Windows MSI per-machine installs. (`151 <https://github.com/mu-editor/pup/issues/151>`_)
- macOS launcher is now a native executable, compiled at packaging time.
This leads to a cleaner user experience when macOS asks if the application should be allowed to access files or other HW devices: with the previous bash-script based solution the user would be asked about ``/bin/bash``. Users are now asked about the proper application name.

Additionally, the main menu should now display the correct application name, instead of ``pythonX.Y`` as before. (`153 <https://github.com/mu-editor/pup/issues/153>`_)


Other Changes
^^^^^^^^^^^^^

- Windows MSI installation now adds a single top-level entry to the Start Menu,
whereas before a directory containing the program launching entry was created:
less is more. (`147 <https://github.com/mu-editor/pup/issues/147>`_)
- Documented Windows MSI limitations regarding non-final PEP-440 versions,
like ``1.1.0b2`` or ``1.1.0rc1``,
and the implications it has on the end-user software upgrade process. (`155 <https://github.com/mu-editor/pup/issues/155>`_)
- Updated the default Python Standalone 3.8 bundle from 3.8.5 to 3.8.11. (`169 <https://github.com/mu-editor/pup/issues/169>`_)

-------------------------

Bug Fixes
^^^^^^^^^

- Fixed macOS signing of bundled files to support Mu Editor 1.0.0b5 that ships Python wheels within a ZIP file. The signing process now recurses into both wheel and ZIP files. (`156 <https://github.com/mu-editor/pup/issues/156>`_)


Other Changes
^^^^^^^^^^^^^

- macOS sign and notarize code cleanup: no need to reinvent ``shutil.which``. (`141 <https://github.com/mu-editor/pup/issues/141>`_)

------------------------

Enhancements
^^^^^^^^^^^^

- On macOS,
``pup`` now signs shared libraries
bundled in wheel files
that the application itself bundles,
as is the case of the Mu Editor
-- this is required for notarization. (`140 <https://github.com/mu-editor/pup/issues/140>`_)


Bug Fixes
^^^^^^^^^

- An ``entitlements.plist`` file,
required for the macOS signing process,
is now bundled.
Previous versions unintentionally failed to do that,
preventing the successful signature
and subsequent notarization
of packaged applications on macOS. (`138 <https://github.com/mu-editor/pup/issues/138>`_)

------------------------

Enhancements
^^^^^^^^^^^^

- The Python Build Standalone package to be used can now be overridden via the ``PUP_PBS_URL`` environment variable -- for now this is a stop gap capability to support packaging 32-bit Windows applications using, for example, `<https://github.com/indygreg/python-build-standalone/releases/download/20200822/cpython-3.7.9-i686-pc-windows-msvc-shared-pgo-20200823T0159.tar.zst>`_. (`#125 <https://github.com/mu-editor/pup/issues/125>`_)


Bug Fixes
^^^^^^^^^

- macOS packaged applications failed running ``tkinter`` and ``turtle`` code when such code was running under a virtual environment -- much like what Mu Editor does. Now fixed. (`122 <https://github.com/mu-editor/pup/issues/122>`_)
- macOS DMG creation failed when ``pup`` was installed into a virtual environment but invoked without activating it. Now fixed. (`125 <https://github.com/mu-editor/pup/issues/125>`_)


Other Changes
^^^^^^^^^^^^^

- Changed the packaging sequence. (`128 <https://github.com/mu-editor/pup/issues/128>`_)

------------------------

Bug Fixes
^^^^^^^^^

- PyPI distributed ``pup`` failed miserably because it did not include all of its own bundled templates -- now fixed. (`118 <https://github.com/mu-editor/pup/issues/118>`_)

------------------------

Enhancements
^^^^^^^^^^^^

- The new ``--nice-name`` packaging option overrides the default application name,
extracted from the distribution's metadata,
with a more user-friendly name. (`41 <https://github.com/mu-editor/pup/issues/41>`_)
- The packaging process can now use custom icons via the ``--icon-path`` option.
Custom icons are used on macOS application bundles and DMG files,
as well as on the Windows Start Menu and *Program and Features* entries. (`90 <https://github.com/mu-editor/pup/issues/90>`_)
- An optional license agreement can now be provided with the ``--license-path`` option.
It must be an ASCII-encoded text file that will be displayed to end-users,
requiring their agreement before the installation can proceed. (`91 <https://github.com/mu-editor/pup/issues/91>`_)
- The Windows packaging process
can now sign the packaged binary ``.exe.``, ``.dll``, and ``.pyd`` files,
as well as the final MSI file. (`97 <https://github.com/mu-editor/pup/issues/97>`_)
- Updated the documentation and added a few entries to the "thanks" list. (`108 <https://github.com/mu-editor/pup/issues/108>`_)


Bug Fixes
^^^^^^^^^

- Fixed a bug that prevented packaging non-signed Windows applications. (`101 <https://github.com/mu-editor/pup/issues/101>`_)
- Fixed a bug that prevented macOS signing and notarization with the ``--nice-name`` option. (`111 <https://github.com/mu-editor/pup/issues/111>`_)


Other Changes
^^^^^^^^^^^^^

- Updated versions of direct dependencies. (`109 <https://github.com/mu-editor/pup/issues/109>`_)