Skip to main content

The PEX packaging toolchain.

Project description

https://github.com/pex-tool/pex/workflows/CI/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 tox:

$ tox -e 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.

Integrating pex into your workflow

If you use tox (and you should!), a simple way to integrate pex into your workflow is to add a packaging test environment to your tox.ini:

[testenv:package]
deps = pex
commands = pex . -o dist/app.pex

Then tox -e package will produce a relocatable copy of your application that you can copy to staging or production environments.

Documentation

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

Development

Pex uses tox for test and development automation. To run the test suite, just invoke tox:

$ tox

If you don’t have tox, you can generate a pex of tox:

$ pex tox -c tox -o ~/bin/tox

Tox provides many useful commands and options, explained at https://tox.wiki/en/latest/ . Below, we provide some of the most commonly used commands used when working on Pex, but the docs are worth acquainting yourself with to better understand how Tox works and how to do more advanced commands.

To run a specific environment, identify the name of the environment you’d like to invoke by running tox --listenvs-all, then invoke like this:

$ tox -e fmt

To run MyPy:

$ tox -e check

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

$ tox -e 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.20.1.tar.gz (4.4 MB view details)

Uploaded Source

Built Distribution

pex-2.20.1-py2.py3-none-any.whl (3.5 MB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: pex-2.20.1.tar.gz
  • Upload date:
  • Size: 4.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pex-2.20.1.tar.gz
Algorithm Hash digest
SHA256 26f66255bfeace420b05a00bac2536ae57548128120f57a8e00a8c3e011d279d
MD5 abb1723f898c0551051f4be158902760
BLAKE2b-256 55041b7703ad77a7b8bdd079cbc77621c7f6baead1ce64ffc86a514b8a61310a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pex-2.20.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.5 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pex-2.20.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 338da8d7d68155a4b3795fc1d72152f1b1e7f7f8d59bb40242b3718f4343776e
MD5 beeab24720d2a78566f295a955e3a08a
BLAKE2b-256 b873908a17d4ba2f48df4d253996685dc809e6133c425fe657d60596e9c221f1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page