Skip to main content

Scripts to Code Sign py2app applications

Project description

CircleCI Maintenance PyPI version

Rationale

These utilities help me sign Python applications built with py2app. This project is a Python rewrite of the one I implemented using Bash scripts. See the CodeSigningScripts repository. The source article for this code and the shell scripts is still here. The motivation to do this in Python was that supporting different Python versions necessitated implementing version specific scripts when signing the Python libraries and applications. I thought that was unsustainable.

The goals for this project are:

  • Consistent CLI interface across Python versions
  • Installable in a developer's virtual environment
  • Default the signing parameters to environment variables. This allows for short CLI invocations. However, still allow CLI parameter overrides
  • Use the built-in keychain to store the notarization tool application ID. This avoid having to either key-in or recall from the bash history a long, long application ID.

Installation

pip install py2appsigner

Dependencies

This project uses Click for CLI handling

Required Environment Variables

The above commands depend on the following environment variables.

PROJECTS_BASE             -  The local directory where the python projects are based
PROJECT                   -  The name of the project;  It should be a directory name
IDENTITY                  - Your Apple Developer ID 

An example, of a PROJECTS_BASE is:

export PROJECTS_BASE="${HOME}/PycharmProjects" 

This should be set in your shell startup script. For example .bash_profile.

The PROJECT environment variable should be set on a project by project basis. I recommend you use direnv to manage these. An example of a .envrc follows:

export PROJECT=pyutmodel
source pyenv-3.10.6/bin/activate

Python Console Scripts

Sign the internal zip file

py2appSign -p 3.11 -d pyut -a Pyut  zipsign

Sign the application

py2appSign -p 3.11 -d pyut -a Pyut  appsign

Notarize the application

appNotarize -d pyut -a Pyut --verbose

Staple the application

appStaple -d pyut -a Pyut --verbose

Verify application signing

appVerify -d pyut -a Pyut

Utility Scripts

Notarization History

notaryTool history
Specify a profile name
notaryTool -p NOTARY_TOOL_APP_ID history

Stores the history in the file notaryHistory.log.

Notary Details

notaryTool information -i <submission id)

e.g. 5f57fc1e-23d3-42ab-b0ad-ec1d2635c4ad

Specify a profile name
notaryTool -p NOTARY_TOOL_APP_ID information -i <submission id>

e.g. 5f57fc1e-23d3-42ab-b0ad-ec1d2635c4ad

Stores the output in the file notary-{submission id}.log

Weird options added over the years

As Python has rolled versions and I use the application signer for different application several weirdnesses have appeared as py2app builds the binary. Rather that patching each individual OS X application I added the sub commands in case you encountered these errors that cause the Apple CLI (/usr/sbin/spctl) to fail

The zipsign subcommand has the following option

--delete-part-files This problem surfaced with Python 3.13. This option removes these bad files that cause appVerify to fail. These are in the internal python313.zip file in the test/zipimport_data subdirectory.

I only remove the .part files and the zipimport_data directory. These leads me to question the existence of test subdirectory in the Python zip file with lots of other subdirectories. I may experiment in the future in entirely removing the test subdirectory. Currently, its size is 7.7 MB.

The appsign subcommand has the followiing options

--fix-lib --fix-sym-link

--fix-lib

This option retrieves the following dynamic library from Homebrew. The one packaged in the .app file is unsignable.

The option copies it into the applicaiton. Currently, works only on Apple Silicon OS X andwith Homebrew installed. You must manally do this on Intel OS X.

See: https://stackoverflow.com/questions/62095338/py2app-fails-macos-signing-on-liblzma-5-dylib

On Intel OS X

/usr/local/Cellar/xz/5.2.5/lib/liblzma.5.dylib

Apple Silicon

/opt/homebrew/opt/xz/lib/liblzma.5.dylib

--fix-sym-link

This option removes the following symbolic link from the application binary before signing

{application}.app/Contents/Resources/lib/python{python version}/site.pyo

Leaving this file in place with a signed and notarized application causes it to fail the appVerify phase and renders the binary unusable


Written by Humberto A. Sanchez II (C) 2026


Note

For all kind of problems, requests, enhancements, bug reports, etc., please drop me an e-mail.

Humberto's Modified Logo

I am concerned about GitHub's Copilot project

I urge you to read about the Give up GitHub campaign from the Software Freedom Conservancy.

While I do not advocate for all the issues listed there I do not like that a company like Microsoft may profit from open source projects.

I continue to use GitHub because it offers the services I need for free. But, I continue to monitor their terms of service.

Any use of this project's code by GitHub Copilot, past or present, is done without my permission. I do not consent to GitHub's use of this project's code in Copilot.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py2appsigner-0.7.0.tar.gz (29.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py2appsigner-0.7.0-py3-none-any.whl (32.6 kB view details)

Uploaded Python 3

File details

Details for the file py2appsigner-0.7.0.tar.gz.

File metadata

  • Download URL: py2appsigner-0.7.0.tar.gz
  • Upload date:
  • Size: 29.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py2appsigner-0.7.0.tar.gz
Algorithm Hash digest
SHA256 d0617fa2146ecd13a9655bdbe78e4821d15bb31b5cf3085be28febef1d1348c1
MD5 10e98ed732d69dde72929c4d883b2245
BLAKE2b-256 9d5b3ba80a2a7a57c5d4f4b1ee5033630dae100fcd71efaa23a2ce500fe1285f

See more details on using hashes here.

Provenance

The following attestation bundles were made for py2appsigner-0.7.0.tar.gz:

Publisher: python-publish.yml on hasii2011/py2appsigner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file py2appsigner-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: py2appsigner-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 32.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py2appsigner-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ef73166985bc3969ba1db1a69d7ef5b80940119ce3df6fc1ba3de5f7fee882d
MD5 03ed37dd7dc1b7c949cf21f8267befc7
BLAKE2b-256 c73cfc40ecbb7b1f910598c49008d5d9a6dc2c21d53a7cfa80195fb8f711f8a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for py2appsigner-0.7.0-py3-none-any.whl:

Publisher: python-publish.yml on hasii2011/py2appsigner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page