Jul 03, 2021 Generic Usage. To package an application, run: $ pup package pip-install-src. Where: pip-install-src is the argument in the pip install pip-install-src command to install the application on the local Python environment. In general, if it’s pip -installable then it’s probably pup -packageable. Installing an official release with pip ¶ This is the recommended way to install Django. The easiest is to use the standalone pip installer. If your distribution already has pip installed, you might need to update it if it’s outdated. If it’s outdated, you’ll know because installation won’t work.
Released:
Pluggable Micro Packager
pup is (in the early stages of becoming) a packaging tool for Python GUI programs.
Fundamentally,its raison d’être is producing macOS and Windows native packagesfor distributing the Mu Editorto Python beginners around the world.As a by-product of that,it may very likely be effective at packaginggeneric Python written GUI programs.If that ever is the case,then great.Otherwise,that’s fine too.
The purpose,again,is to package Mu Editorfor macOS and Windows distribution.
The current version of pup,while still very limited and somewhat exploratory,can package,at least,the Mu Editorand puppy into distributable:
Windows MSI installer files
Minimally featured, user-installable,with an optional License Agreement GUI,adding an entry to the Windows Start Menu,with an optional custom icon.
The packaged binary files can be signed,as well as the final MSI file.
As a side-effect of the process,a relocatable directory holding the aplication is produced,paving the way for the creation “portable” Windows applications.
macOS DMG files
Holding the relocatable .app application bundle,with an optional custom icon,properly signed and notarized as required for distribution,
Including an optional License Agreement GUIand custom volume icon.
As of this writing,pup should be able to package any Python GUI application that:
No specific efforts have been put forth to ensure that that is the case,however,so YMMV.
pup is distributed via PyPI.Install it with:
To package an application, run:
Where:
<pip-install-src> is the argumentin the pip install <pip-install-src> commandto install the application on the local Python environment.
In general,if it’s pip-installable then it’s probably pup-packageable.
This usage patternassumes that the application GUI is launchable with python -m <name>,where <name> is extractedfrom the metadata of a wheel created from <pip-install-src>.If that is not the case,pup can be told otherwise.Read on.
When completed,the final distributable artifact will be placed under ./dist/.
Use --launch-module=<name>to set the module namethat should be used to launch the application GUI,as with the python -m <name> command.
Use --nice-name=<name>to set a “nice name” for the applicationto be used used throughout the packaging process:in file and directory names,for macOS’s application bundle and DMG file names,and for the Windows Start Menu entry.
When omitted,that name is obtained from the metadata of a wheelcreated from <pip-install-src>,that very often does not match the exact product spelling,as communicated to end-users.
Use --icon-path=<icon-path>to include a custom icon in the packaging process.
On macOS the given file should be anICNS filewhich will be used as the icon for both the packaged application bundleand the DMG file volume icon.
On Windows the file should be anICO filewhich will be used on the Windows Start Menu entry andon the Windows Programs and Features listing.
Use --license-path=<license-path> to bundle the given license textand require users to accept it before installation.
The given <license-path> must be an ASCII-encoded text file.
Signing is optional and varies slightly between platforms.
pup will only sign the application for distributionwhen all of the following conditions are true.On macOS,pup will also complete the Apple required notarization process:for that,the packaging system must be online andable to connect to Apple’s notarization servicesover the internet.
macOS
Windows
In the first run,pup downloads one or more files,which are cached locally for later use:
pup logs its progress to STDERR,with fewer per-event details when it’s a TTY.The logging level defaults to INFO and can be changedwith either the --log-level CLI option,or by setting the PUP_LOG_LEVEL environment variable.
Other than the locally cached files,pup creates files under:
Requirements for signing:
Run:
Where:
Then, assuming the current working directory is Mu Editor’s repository root, run:
Note:
Once completed:
Requirements for signing and notarization:
Run:
Where:
Then, assuming the current working directory is Mu Editor’s repository root, run:
Note:
Once completed:
To learn more about puprefer to the online documentation:at this early stage,it is mostly a collectionof thoughts and ideasaround behaviour,requirements,and very very rough internal design.
Development moves forwardon GitHub at https://github.com/mu-editor/pup/.
pup is in the process of being created by Tiago Montes,with the wonderful support of the Mu development team.
1.0.0a10 pre-release
1.0.0a9 pre-release
1.0.0a8 pre-release
1.0.0a7 pre-release
1.0.0a6 pre-release
1.0.0a5 pre-release
1.0.0a4 pre-release
1.0.0a3 pre-release
1.0.0a2 pre-release
1.0.0a1 pre-release
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size pup-1.0.0a10-py3-none-any.whl (37.9 kB) | File type Wheel | Python version py3 | Upload date | Hashes |
Filename, size pup-1.0.0a10.tar.gz (33.8 kB) | File type Source | Python version None | Upload date | Hashes |
Algorithm | Hash digest |
---|---|
SHA256 | 43ddbc9ca6345898b895448e8f682b93f93682e8ea60fe069affa132e430ee6f |
MD5 | 529ac32b8847c5654ea77c42ba65c61f |
BLAKE2-256 | 91cd1e0f871bfaa4860b124ee9aba505b71f365f8edfe45f98d6fe4701f1ed1d |
Algorithm | Hash digest |
---|---|
SHA256 | d0b20bc59f2cc30a23c024c825229a0791da7021de014f528ddbfbc954d3228f |
MD5 | 80273ea2c7bb62222cfff0409b442779 |
BLAKE2-256 | 7ed6661bf024b3504d5434c71e2e8e115e8804b49e1a7770e969bca2acebd16b |