Pyzify

A small program to create self-contained executable Python "zipapps" using shiv.

Table of contents

• Introduction
• Installation
• Usage
• Known issues and limitations
• Getting help
• Contributing
• License
• Authors and history
• Acknowledgments

Introduction

Pyzify is a small program that does two things:

1. Creates a self-contained and executable Python zipapp from your Python source code. The resulting binary contains a bootstrap component and a pyz bundle of your application files with all the Python dependencies included. To run, the application only needs a Python interpreter of the right version on users' computers – users don't need to install other Python packages. It's almost like a regular compiled program!
2. Bundles the executable application into a zip archive suitable for distribution. The zip archive contains a README file with information about the application; the README is constructed using a template that you supply, letting you customize its contents.

Pyzify is uses shiv to do the real work. It adds some bootstrap code to test the version of Python at run-time and additional steps to create the zip archive for distribution.

Installation

Usage

Known issues and limitations

Getting help

If you find an issue, please submit it in the GitHub issue tracker for this repository.

Contributing

I would be happy to receive your help and participation with enhancing Handprint! Please visit the guidelines for contributing for some tips on getting started.

License

Software produced by the Caltech Library is Copyright © 2021 California Institute of Technology. This software is freely distributed under a BSD/MIT type license. Please see the LICENSE file for more information.

Authors and history

Pyzify started as a script used by the author to create self-contained applications for Handprint and eprints2bags. It was spun out as its own project late in the year 2021.

Acknowledgments

This work was funded by the California Institute of Technology Library.

The vector artwork used as a starting point for the logo for this repository was created by Komkrit Noenpoempisut for the Noun Project. It is licensed under the Creative Commons Attribution 3.0 Unported license. The vector graphics was modified by Mike Hucka to change the color.