Sharing Python apps can be tricky. Most solutions require a lot of setup or produce huge files. PyInstaller, a popular tool, can be stubborn and needs lots of tweaks to work right. Nuitka compiles Python to binaries but can create large files that take ages to build. Now, there’s a new way called PyApp that promises to make things easier.

What is PyApp and How Does It Work?

PyApp is built with Rust, a fast programming language. Instead of turning Python code directly into an executable, PyApp creates a small, self-contained binary. When someone runs it, the binary unpacks your Python project into a folder and then runs it from there. The best part? The user doesn’t need Python installed on their system at all.

Getting Started with PyApp

Unlike tools such as PyInstaller, PyApp isn’t a library or a simple command-line tool. Instead, you create a custom version of PyApp for each Python project you want to share. First, you need to clone PyApp’s source code and set it up in its own folder. Because it’s written in Rust, you’ll need to have Rust installed and know how to compile Rust programs. If you’re new to Rust, there are tutorials to help you get started.

Next, you need to prepare your Python program as a wheel file (.whl). This binary package includes your code and any prebuilt libraries it needs. If you haven’t made a wheel before, there are guides and videos that walk you through creating one. You can also get wheels directly from PyPI, the Python package index.

Configuring Your Build with Environment Variables

PyApp uses environment variables to understand what you want to package. You specify the project name, version, and path to the wheel file. You can also tell it which module or script to run and whether to embed a copy of Python inside the binary, making it totally standalone. Setting these variables allows you to customize how your app is built and run.

For example, PYAPP_PROJECT_NAME defines your project’s name, matching your pyproject.toml file or the wheel’s name. PYAPP_PROJECT_PATH points to the wheel file. If your program runs as a module, you set PYAPP_EXEC_MODULE to tell PyApp which module to execute. For projects with specific startup scripts, PYAPP_EXEC_SPEC lets you specify that script. If you want the binary to include Python itself, set PYAPP_DISTRIBUTION_EMBED to 1. This makes the final file larger but eliminates the need for internet downloads on run.

Building and Running Your PyApp Binary

Once your environment variables are set, navigate to the PyApp source folder and build the tool with the command: cargo build –release. This might take some time, as PyApp has many dependencies. After building, you’ll find the executable in the target/release folder. You can rename it however you like.

Testing the binary is straightforward. Just run it in your terminal. It will unpack itself and then launch your Python program. If there are errors, double-check your environment variables and startup settings. The first time you run it, PyApp unpacks into a folder usually inside your user profile. On subsequent runs, it uses that unpacked version, making startup faster.

If you want to control where it unpacks, you can set an environment variable like PYAPP_INSTALL_DIR_. Just replace with your project’s name in uppercase. This way, you can specify a custom directory for the unpacked files. Keep in mind, this setting is temporary and only applies to the current run.

Extra Features and Tips

PyApp includes some handy commands built-in. You can remove the unpacked app with pyapp self remove or reinstall it with pyapp self restore. Remember, if you used a custom install directory environment variable, you need to set it again when running these commands.

One thing to watch out for: Windows antivirus tools might flag PyApp-packed executables as suspicious. This is because they aren’t signed by default. Signing your executables can help reduce false positives, especially if you’re distributing to others.

Overall, PyApp offers a promising new way to package Python apps easily and efficiently. With minimal fuss, it creates a standalone executable that runs your code without requiring Python on the target system. If you’re tired of complicated packaging tools, PyApp might be just what you need.

Inspired by

• https://www.infoworld.com/article/4030697/pyapp-an-easy-way-to-package-python-apps-as-executables.html

Sources

• gmpg.org
• github.com
• python.org
• ofek.dev
• ofek.dev