PyMacApp 1.1.0

Basic Tools to Build, Package, Sign, and Notorize Python Apps for MacOS

PyMacApp

pip3 install PyMacApp

This Repo creates a project that you can clone to streamline MacOS python desktop app development. It contains all necessary scripts to build your final project, as well as code-sign them from Apple (Developer Account required for some features).

Quickstart: Building & Packaging Your App

from pymacapp.logger import set_level
from pymacapp.helpers import get_first_application_hash, get_first_installer_hash
import logging

APPLE_DEVELOPER_ID_EMAIL = # fill this in
APP_SPECIFIC_PASSWORD = # fill this in

# set logging level for pymacapp's built-in logger
set_level(logging.DEBUG)

# create an application object
app = App(name="My First App", identifier="com.identifier")
# setup your app by specifying the main python script ('entry point')
app.setup(script="./src/main.py")
# build your app
app.build()
# sign your app using the first available hash (see Setup for more)
app.sign(get_first_application_hash())


# create a package object
package = Package(app, version="0.1", identifier="com.identifier.pkg")
# build your package
package.build(postinstall_script="./src/Scripts/postinstall")
# sign your package
package.sign(get_first_installer_hash())
# notorize with your apple developer id
package.notorize(APPLE_DEVELOPER_ID_EMAIL, APP_SPECIFIC_PASSWORD)
# wait for the notary agent to respond
    # if valid, it will automatically staple
    # if invalid, it will stop
package.wait()

Currently supports

This currently supports (and has been tested on) Python 3.9.9 on MacOS 11.6. This tool may work on other systems, but has not been tested.

• Building .app files (beta)
• Signing .app files (beta)
• Building .pkg files (beta)
• Signing .pkg files (alpha)
• Notorizing .pkg files (alpha)
• Stapling .pkg files (alpha)

Setup

Precursor - PyPi: PyMacApp

pip3 install PyMacApp

• Uses PyInstaller, should install automatically

Part 1: Developer Account

Note: This section is taken from: https://gist.github.com/txoof/0636835d3cc65245c6288b2374799c43

(1/2) Create a developer account with Apple

• Go to https://developer.apple.com and shell out $99 for a developer account
• Download and install X-Code from the Apple App Store
• Open and run X-Code app and install whatever extras it requires
• Open the preferences pane (cmd+,)
• click the + in the lower right corner choose Apple ID
• enter your apple ID and password

(2/2) Create an App-Specific password

• Instructions from Apple to create: https://support.apple.com/en-us/HT204397
• Save this password (you will need it for notorizing)

Part 2: Get Your Hashes

(1/3) Create Certificates with XCode

• Open XCode
• In the top-apple Menu, go to XCode > Preferences > Accounts > Your Account > In the team, chose the Admin team > Manage Certificates in the bottom-right
• click the plus in the bottom corner
• choose "Developer ID Application"
• repeating, click the plus in the bottom corner
• choose "Developer ID Installer"

(2/3) Get Certificates and Add to Project

• run:

security find-identity -p basic -v

• your output will look like:

1. HASH_OF_ID_HERE "Developer ID Application: ..."

2. HASH_OF_ID_HERE "Developer ID Installer: ..."

   2 valid identities found

• copy the appropriate hashes or simply use get_first_application_hash() or get_first_installer_hash() by importing them (from pymacapp.helpers import get_first_application_hash, get_first_installer_hash)

(3/3) Create your Identifiers

• developer.apple.com
• choose "account" in top right
• login
• "Certificates, IDs, and Profiles"
• on the left, switch to "Identifiers"
• create two App IDs, one for your .app and one for your .pkg
• it may be helpful to do something like com.your-domain.app-name for the .app and com.your-domain.app-name.pkg for the .pkg

Coding Your App

Code your app however you'd like. You'll need to identify a main script file (main.py or app.py); where ever you run your program from, that is your main script file.

Advanced Customization

Pre- and Post-Install Scripting

Better docs coming soon; see example under Quickstart.

Project History

This project began while performing work for Georgetown University's Department of Italian Studies. The code herein was needed to develop applications within the Department. Some of the code contains outside work, so this was a joint collaboration.