Skip to main content

The PEX packaging toolchain.

Project description

https://github.com/pex-tool/pex/actions/workflows/ci.yml/badge.svg?branch=main https://img.shields.io/pypi/l/pex.svg https://img.shields.io/pypi/v/pex.svg https://img.shields.io/pypi/pyversions/pex.svg https://img.shields.io/pypi/wheel/pex.svg https://img.shields.io/discord/1205942638763573358

Overview

pex is a library for generating .pex (Python EXecutable) files which are executable Python environments in the spirit of virtualenvs. pex is an expansion upon the ideas outlined in PEP 441 and makes the deployment of Python applications as simple as cp. pex files may even include multiple platform-specific Python distributions, meaning that a single pex file can be portable across Linux and OS X.

pex files can be built using the pex tool. Build systems such as Pants, Buck, and {py}gradle also support building .pex files directly.

Still unsure about what pex does or how it works? Watch this quick lightning talk: WTF is PEX?.

pex is licensed under the Apache2 license.

Installation

To install pex, simply

$ pip install pex

You can also build pex in a git clone using uv:

$ uv run dev-cmd package
$ cp dist/pex ~/bin

This builds a pex binary in dist/pex that can be copied onto your $PATH. The advantage to this approach is that it keeps your Python environment as empty as possible and is more in-line with what pex does philosophically.

Simple Examples

Launch an interpreter with requests, flask and psutil in the environment:

$ pex requests flask 'psutil>2,<3'

Save Dependencies From Pip

Or instead freeze your current virtualenv via requirements.txt and execute it anywhere:

$ pex $(pip freeze) -o my_virtualenv.pex
$ deactivate
$ ./my_virtualenv.pex

Ephemeral Environments

Run webserver.py in an environment containing flask as a quick way to experiment:

$ pex flask -- webserver.py

Launch Sphinx in an ephemeral pex environment using the Sphinx entry point sphinx:main:

$ pex sphinx -e sphinx:main -- --help

Using Entry Points

Projects specifying a console_scripts entry point in their configuration can build standalone executables for those entry points.

To build a standalone pex-tools-executable.pex binary that runs the pex-tools console script found in all pex version 2.1.35 and newer distributions:

$ pex "pex>=2.1.35" --console-script pex-tools --output-file pex-tools-executable.pex

Specifying A Specific Interpreter

You can also build pex files that use a specific interpreter type:

$ pex "pex>=2.1.35" -c pex-tools --python=pypy -o pex-tools-pypy-executable.pex

Most pex options compose well with one another, so the above commands can be mixed and matched, and equivalent short options are available.

For a full list of options, just type pex --help.

Documentation

More documentation about Pex, building .pex files, and how .pex files work is available at https://docs.pex-tool.org.

Development

Pex uses uv with dev-cmd for test and development automation. After you have installed uv, to run the Pex test suite, just run dev-cmd via uv:

$ uv run dev-cmd

The dev-cmd command runner provides many useful options, explained at https://pypi.org/project/dev-cmd/ . Below, we provide some of the most commonly used commands when working on Pex, but the docs are worth acquainting yourself with to better understand how dev-cmd works and how to execute more advanced work flows.

To run a specific command, identify the name of the command you’d like to invoke by running uv run dev-cmd --list, then invoke the command by name like this:

$ uv run dev-cmd format

That’s a fair bit of typing. An shell alias is recommended, and the standard is uvrc which I’ll use from here on out.

To run MyPy:

$ uvrc typecheck

All of our tests allow passthrough arguments to pytest, which can be helpful to run specific tests:

$ uvrc test-py37-integration -- -k test_reproducible_build

To run Pex from source, rather than through what is on your PATH, invoke via Python:

$ python -m pex

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pex-2.74.1.tar.gz (5.2 MB view details)

Uploaded Source

Built Distribution

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

pex-2.74.1-py2.py3-none-any.whl (3.9 MB view details)

Uploaded Python 2Python 3

File details

Details for the file pex-2.74.1.tar.gz.

File metadata

  • Download URL: pex-2.74.1.tar.gz
  • Upload date:
  • Size: 5.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pex-2.74.1.tar.gz
Algorithm Hash digest
SHA256 6b864ecaf8f4a7e432c128c2dc1a087375be0f36444b9aeac2c16a8d0d8f4a66
MD5 6bd9917ec5ac055a044a9a204fc48e28
BLAKE2b-256 6f857c46595c8f299cf6e12f0498e835ae54762726b626029f1f730f870a37f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pex-2.74.1.tar.gz:

Publisher: release.yml on pex-tool/pex

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

File details

Details for the file pex-2.74.1-py2.py3-none-any.whl.

File metadata

  • Download URL: pex-2.74.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pex-2.74.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 45a1b76469b26f381e288b3ca2db6b16bef9630f01fb6b39d8b76241f53a5a68
MD5 9f6240de72c87417557fc414c3f1e7b1
BLAKE2b-256 c0e027dc5d4f23cb28b8890fbf1117a0f547501154a32eebf401416a18cc62a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pex-2.74.1-py2.py3-none-any.whl:

Publisher: release.yml on pex-tool/pex

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