hatch-pex 0.1.3

Hatch plugin for building PEX binaries.

hatch-pex 🍳

This plugin adds a PEX executable build target for Hatch.

Quickstart

To make the 'pex' target available in Hatch, you just need to add hatch-pex as a dependency of the pex build target.

[tool.hatch.build.targets.pex]
dependencies = ["hatch-pex"]

From there, you can build with Hatch!

$ hatch build -t pex
$ ls dist/pex
myapp.pex

To add a scie build, just set the scie type

[tool.hatch.build.targets.pex]
dependencies = ["hatch-pex"]
scie = "eager"

$ hatch build -t pex
$ ls dist/pex
myapp.pex   myapp

Comparison to PyApp

Hatch's built-in 'binary' build target will generate a self-extracting binary including a Python interpreter and your code using PyApp. This is functionally identical to PEX's scie binaries, except that a scie PEX does not need to be compiled for every Python project.

Instead, the scie binary is just a "dumb" pre-built binary that the PEX zipapp gets appended to (with some metadata to tell the binary how to run it). This works because executables can have arbitrary data appended to them, and a zip can have arbitrary data before it's header, and both are still valid.

Configuration

Since all this plugin really does under the hood is call pex with your project and entry-points as arguments, it is about as configurable as the pex command itself. pex --help has a good explanation of all the options here, and docs.pex-tool.org is also very informative.

When you run hatch build -t pex, the builder will effectively run the following command for each entry in your project.scripts table:

$ pex \
    --project "${PROJECT}" \
    --output-file "${SCRIPT_NAME}.pex" \
    --script "${SCRIPT_NAME}"
    # ... other config args here ...

Pretty much all of the below configuration is just passed straight to the pex command as arguments.

If you have an empty project.scripts, or you set tool.hatch.build.targets.pex.scripts to an empty list, then hatch-pex will build an interactive PEX.

Options

[tool.hatch.build.targets.pex]
scripts = [] # Limit the scripts that get made into PEXes
pex-args = ["--venv"] # Set default arguments to pass to `pex`
scie = false # Set to "eager" or "lazy" to build a scie PEX.
suffix = ".pex" # The suffix of the output file.

# Pass '--scie-only' or '--pex-only' to specify if
# you want one or the other

# You can override your defaults for each PEX,
# add extra arguments, or add additional PEXes by defining tables...
[tool.hatch.build.targets.pex.script.'somescript']
pex-args = []
extra-pex-args = [] 
scie = false
suffix = ".pex"
command = ["--script", "{script}"]
# "{script}" gets replaced with the above name

# If there are no scripts, an interactive PEX is built with the
# project name as the executable name.
# You can also manually configure one.
[tool.hatch.build.targets.pex.interactive]
name = "somename" # the project.name by default
pex-args = []
extra-pex-args = []
scie = false
suffix = ".pex"
# 'command' is not valid here