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.91.2.tar.gz (5.3 MB view details)

Uploaded Source

Built Distributions

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

pex-2.91.2-py3.py312-none-any.whl (1.8 MB view details)

Uploaded Python 3Python 3.12

pex-2.91.2-py2.py35.py36.py37.py38.py39.py310.py311-none-any.whl (4.0 MB view details)

Uploaded Python 2Python 3.10Python 3.11Python 3.5Python 3.6Python 3.7Python 3.8Python 3.9

File details

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

File metadata

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

File hashes

Hashes for pex-2.91.2.tar.gz
Algorithm Hash digest
SHA256 445095e2bbec4ea137ad72c8e5c08070cf2e3b088ea2ec229196d0969bfd1de4
MD5 7a3eb4f1340fab69b089278671495a20
BLAKE2b-256 cbf654d9fc4a3ebe9cd53ceb2315be3b7c24a7f3ed501e6c4cb03a7d6893da5c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pex-2.91.2.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.91.2-py3.py312-none-any.whl.

File metadata

  • Download URL: pex-2.91.2-py3.py312-none-any.whl
  • Upload date:
  • Size: 1.8 MB
  • Tags: Python 3, Python 3.12
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pex-2.91.2-py3.py312-none-any.whl
Algorithm Hash digest
SHA256 82f3ec44c8c86e03902177d97bf9c4e5b82d3d140c064bc6df3f498c0aa5f0c4
MD5 04ad8431a306bd8b12c29d3d97fb9792
BLAKE2b-256 58c2c828c005f88a404fa1ef9cbeeb64ae1500a4bc902cb2f7e336d10fc8f352

See more details on using hashes here.

Provenance

The following attestation bundles were made for pex-2.91.2-py3.py312-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.

File details

Details for the file pex-2.91.2-py2.py35.py36.py37.py38.py39.py310.py311-none-any.whl.

File metadata

File hashes

Hashes for pex-2.91.2-py2.py35.py36.py37.py38.py39.py310.py311-none-any.whl
Algorithm Hash digest
SHA256 06218d551f33b1c860674b98700198e6595eaf53a36596efab5c6209ed09a4a6
MD5 e87ed5c1aaf1003d77b3686b6a5145ec
BLAKE2b-256 da1f9b5f5d5aac5e0db59a2c9127302b9ba7ffa674c8a17a97b44c07694dcc3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pex-2.91.2-py2.py35.py36.py37.py38.py39.py310.py311-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