Skip to main content

The PEX packaging toolchain.

Project description

https://github.com/pantsbuild/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

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://pex.readthedocs.io.

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.readthedocs.io/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 format-run

To run MyPy:

$ tox -e typecheck

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

Contributing

To contribute, follow these instructions: https://www.pantsbuild.org/docs/contributor-overview

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

Uploaded Source

Built Distribution

pex-2.1.99-py2.py3-none-any.whl (2.7 MB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: pex-2.1.99.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for pex-2.1.99.tar.gz
Algorithm Hash digest
SHA256 3feaf424e495c0855691044ebec6e9528730078c741eb572cbda18f4274d8fab
MD5 5bad6ba6c84a71d787674abb2d64399d
BLAKE2b-256 f8767e17f82344dd14a5a9cf76391cdf6edeede0e409432a319db98512d11375

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pex-2.1.99-py2.py3-none-any.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for pex-2.1.99-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b9e7a1070c4f616b9114e10475e9c49f3ff9332789e581edf4b5646ae477d0b1
MD5 f3c688d57e60ef4a792325c5c12f105b
BLAKE2b-256 cf44b4bddb5599370e86a8366e21fb6b2bb2a703e0d0d7a594e20d70f7082940

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