Pack Python Prograns Into A Standalone Mac App

Feb 04, 2018  In this video we will look at how to build your python application into a standalone app that can be opened outside of python using pyinstaller. This video uses a very basic application as the app. Dec 24, 2015  By default, your Mac comes installed with Python 2.7, no installation necessary! However, if you want some of the new features of Python such as 'print' being a function now instead of a standalone command, then you are going to want to install Py.

Nov 28, 2015  In this tutorial we’ll be using py2app to create a standalone OSX application from a Python 2 or 3 source code with a simple Tkinter user interface. 'py2app is a Python setuptools command which will allow you to make standalone application bundles and plugins from Python scripts. Py2app is similar in purpose and design to py2exe for Windows.' Relevant links about py2app: Documentation Source. I want to create a GUI application which should work on Windows and Mac. For this I've chosen Python. The problem is on Mac OS X. There are 2 tools to generate an '.app' for Mac: py2app and pyinstaller. Py2app is pretty good, but it adds the source code in the package. I don't want to.

Related

How To Use the pathlib Module to Manipulate Filesystem Paths in Python 3 Tutorial
How To Install the Django Web Framework on Ubuntu 20.04 Tutorial

Tutorial

Introduction

All Python libraries (i.e. application packages) that you download using a package manager (e.g. pip) are distributed using a utility dedicated to do the job. These utilities create “Python distributions” which are basically versioned (and compressed) archives. All related elements to what’s being distributed, such as source files and resource files, are contained within it.

In this DigitalOcean article, we are going to talk about the necessary tools for distribution and go over the key steps to allow you to package your own useful libraries, modules, or applications – which should help you when deploying your project on a droplet or sharing on the internet.

Python Distributions and Packages

Even if you have worked only a little with Python, you will be familiar with the concept of using a package manager (e.g. pip, easy_install) to download modules and libraries (e.g. application development frameworks) which are then imported and used to create a new one.

These package management tools, operating locally, connect to a source (i.e. Python Package Index - PyPI) and perform a desired action (e.g. search and install) as they work these resources which are actually called Python distributions.

The way to distribute an application consists of wrapping its directory with some must-have files (along with a few recommended ones), specifying related elements (e.g. resources, dependencies etc.) and releasing it or using it elsewhere…that simple.

Note: You are highly encouraged to work with virtual environments to isolate Python downloads, modules, and applications you are working with.

Python Packages

In Python, a package [technically] is an importable directory (with __init__.py) containing source files (i.e. modules). This shall not be confused with operating-system packages, which are [technically] actual applications (i.e. a Debian package). However, it must be noted that Python distributions are indeed called packages as well.

Example package structure:

Python Applications

Although anything from a single file to one with hundreds scattered across various packages can be considered an application in Python, in most realistic scenarios, an application will consist of multiple modules and a certain amount of external imports (from libraries).

Example application structure:

Python Distribution Tools and Libraries

Given the popular nature of Python and the rich amount of third-party libraries / applications written for it, a simpler and unified way of distributing has always been a necessity. There have been several different tools and libraries used for creating Python distributions.

In order to deal with the tasks of distribution, Python distribution utilities toolset distutils was created.

Python Package Index (PyPI)

Python Package Index, or PyPI, is a central [online] repository for projects (Python distributions). Package managing tools such as pip use this repository in order to host, find and install them.

Getting Started

Let's begin with creating a simple, general Python flask application [structure] which we then can use to package.

Creating the Application Structure

We aim to create an example that resembles most real-world projects. Therefore, it will be best to imagine a scenario with modularised components.

Example structure:

Create the folders:

Edit run.py using nano:

Place the contents:

Save and exit using CTRL+X and confirm with with Y.

Edit config.py using nano:

Place the contents:

Save and exit using CTRL+X and confirm with with Y.

Edit app/init.py using nano:

Place the contents:

Save and exit using CTRL+X and confirm with with Y.

Edit app/module_one/controllers.py using nano:

Place the contents:

Save and exit using CTRL+X and confirm with with Y.

Place the contents:

Edit app/templates/module_one/hello.html using nano:

Place the contents:

<pre>
&lt!DOCTYPE html>
&lthtml lang=“en”>
&lthead>
&lttitle>{% block title %}My Site{% endblock %}</title>
{% block css %}
{% endblock %}
&ltmeta name=“viewport” content=“width=device-width, initial-scale=1.0”>
&lt/head>
&ltbody>
Hello, world!
&lt/body>
&lt/html>
</pre>

Save and exit using CTRL+X and confirm with with Y.

Beginning with Application Distribution / Packaging

Pack Python Programs Into A Standalone Mac App Free

Having created an exemplary application structure of a web site that uses flask, we can continue with taking the first step into preparing the distribution.

Altering the Folder Structure

In order to package our application well, we need to make some additions to our folder structure.

Alter the folder structure to create necessary files:

Create the setup.py

Pack Python Programs Into A Standalone Mac Apps

Place the below self explanatory contents:

Save and exit using CTRL+X and confirm with with Y.

Create the MANIFEST.in

If you need to ship extra directories (e.g. static or templates), you need to explicitly state them in the manifest to be packaged. We will do this inside the MANIFEST.in.

Place the below self explanatory contents:

Save and exit using CTRL+X and confirm with with Y.

And that’s it! Your Python distribution package is ready to be installed and shipped.

Additional Files

Please remember that in order to have a complete distribution, your file/directory must contain (and linked):

  • README.txt

  • MANIFEST.in

  • LICENSE.txt

Pack Python Programs Into A Standalone Mac Application

Working With the Distribution Ready Application

As we have finalized creation of our application followed by making necessary amendments to the file structure to prepare it for a flawless distribution build, we can begin with going through the packaging operations.

How to Create The Distribution File

Mac

In order to generate a distribution file copy, run the following:

Pack Python Programs Into A Standalone Mac App Download

This command will go through your setup, print out the operations being performed and generate a tar archive inside the newly created dist directory, similar to:

Note: Since we did not populate all the sub-folders (i.e. static) and worked with additional files (e.g. README.txt), you might see some warnings during the creation process.

How to Install The Application

From now on, your application can be installed and used by others using the setup.py file created.

In order to install the application, run the following:

If this installation is for development and the requirements are also to be installed, run the following:

How to Share Your Application

If you would like to share your code on the Python Packaging Index, you can do so by initiating the “register” procedure as per the following:

You will need to complete the procedure by following the on-screen instructions.

If you have a registered login, in order to just upload, you can use the following:

How to Create Packages of Your Application’s New Versions

  1. Edit the setup.py file with a text editor (e.g. nano) and set the new version number: version='0.1.1'

  2. Edit the CHANGES.txt to reflect the changes

  3. Make the necessary adjustments to the LICENSE.txt and README.txt

  4. Upload your code following the previous step.

<div class=“author”>Submitted by: <a
href=“https://twitter.com/ostezer”>O.S. Tezer</a></div>