***
PEX
***
.. image:: https://github.com/pex-tool/pex/workflows/CI/badge.svg?branch=main
:target: https://github.com/pex-tool/pex/actions?query=branch%3Amain+workflow%3ACI
.. image:: https://img.shields.io/pypi/l/pex.svg
:target: https://pypi.org/project/pex/
.. image:: https://img.shields.io/pypi/v/pex.svg
:target: https://pypi.org/project/pex/
.. image:: https://img.shields.io/pypi/pyversions/pex.svg
:target: https://pypi.org/project/pex/
.. image:: https://img.shields.io/pypi/wheel/pex.svg
:target: https://pypi.org/project/pex/#files
.. image:: https://img.shields.io/discord/1205942638763573358
:target: https://pex-tool.org/discord
.. contents:: **Contents**
Overview
========
pex is a library for generating .pex (Python EXecutable) files which are
executable Python environments in the spirit of `virtualenvs <http://virtualenv.org>`_.
pex is an expansion upon the ideas outlined in
`PEP 441 <https://peps.python.org/pep-0441/>`_
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
<http://pantsbuild.org/>`_, `Buck <http://facebook.github.io/buck/>`_, and `{py}gradle <https://github.com/linkedin/pygradle>`_ also
support building .pex files directly.
Still unsure about what pex does or how it works? Watch this quick lightning
talk: `WTF is PEX? <http://www.youtube.com/watch?v=NmpnGhRwsu0>`_.
pex is licensed under the Apache2 license.
Installation
============
To install pex, simply
.. code-block:: bash
$ pip install pex
You can also build pex in a git clone using tox:
.. code-block:: bash
$ 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:
.. code-block:: bash
$ pex requests flask 'psutil>2,<3'
Save Dependencies From Pip
~~~~~~~~~~~~~~~~~~~~~~~~~~
Or instead freeze your current virtualenv via requirements.txt and execute it anywhere:
.. code-block:: bash
$ 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:
.. code-block:: bash
$ pex flask -- webserver.py
Launch Sphinx in an ephemeral pex environment using the Sphinx entry point ``sphinx:main``:
.. code-block:: bash
$ 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:
.. code-block:: bash
$ 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:
.. code-block:: bash
$ 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``:
.. code-block:: 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 <https://tox.wiki/en/latest/>`_ for test and development automation. To run
the test suite, just invoke tox:
.. code-block:: bash
$ tox
If you don't have tox, you can generate a pex of tox:
.. code-block::
$ 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:
.. code-block::
$ tox -e fmt
To run MyPy:
.. code-block::
$ tox -e check
All of our tox test environments allow passthrough arguments, which can be helpful to run
specific tests:
.. code-block::
$ tox -e py37-integration -- -k test_reproducible_build
To run Pex from source, rather than through what is on your PATH, invoke via Python:
.. code-block::
$ python -m pex
Raw data
{
"_id": null,
"home_page": "https://github.com/pex-tool/pex",
"name": "pex",
"maintainer": null,
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,<3.14,>=2.7",
"maintainer_email": null,
"keywords": "package, executable, virtualenv, lock, freeze",
"author": "The PEX developers",
"author_email": "developers@pex-tool.org",
"download_url": "https://files.pythonhosted.org/packages/6b/55/914d3b17874f9960f66d3f914cbce2a1ef3dab487df3e36d419c124934c1/pex-2.27.1.tar.gz",
"platform": null,
"description": "***\nPEX\n***\n.. image:: https://github.com/pex-tool/pex/workflows/CI/badge.svg?branch=main\n :target: https://github.com/pex-tool/pex/actions?query=branch%3Amain+workflow%3ACI\n\n.. image:: https://img.shields.io/pypi/l/pex.svg\n :target: https://pypi.org/project/pex/\n\n.. image:: https://img.shields.io/pypi/v/pex.svg\n :target: https://pypi.org/project/pex/\n\n.. image:: https://img.shields.io/pypi/pyversions/pex.svg\n :target: https://pypi.org/project/pex/\n\n.. image:: https://img.shields.io/pypi/wheel/pex.svg\n :target: https://pypi.org/project/pex/#files\n\n.. image:: https://img.shields.io/discord/1205942638763573358\n :target: https://pex-tool.org/discord\n\n.. contents:: **Contents**\n\nOverview\n========\npex is a library for generating .pex (Python EXecutable) files which are\nexecutable Python environments in the spirit of `virtualenvs <http://virtualenv.org>`_.\npex is an expansion upon the ideas outlined in\n`PEP 441 <https://peps.python.org/pep-0441/>`_\nand makes the deployment of Python applications as simple as ``cp``. pex files may even\ninclude multiple platform-specific Python distributions, meaning that a single pex file\ncan be portable across Linux and OS X.\n\npex files can be built using the ``pex`` tool. Build systems such as `Pants\n<http://pantsbuild.org/>`_, `Buck <http://facebook.github.io/buck/>`_, and `{py}gradle <https://github.com/linkedin/pygradle>`_ also\nsupport building .pex files directly.\n\nStill unsure about what pex does or how it works? Watch this quick lightning\ntalk: `WTF is PEX? <http://www.youtube.com/watch?v=NmpnGhRwsu0>`_.\n\npex is licensed under the Apache2 license.\n\n\nInstallation\n============\n\nTo install pex, simply\n\n.. code-block:: bash\n\n $ pip install pex\n\nYou can also build pex in a git clone using tox:\n\n.. code-block:: bash\n\n $ tox -e package\n $ cp dist/pex ~/bin\n\nThis builds a pex binary in ``dist/pex`` that can be copied onto your ``$PATH``.\nThe advantage to this approach is that it keeps your Python environment as empty as\npossible and is more in-line with what pex does philosophically.\n\n\nSimple Examples\n===============\n\nLaunch an interpreter with ``requests``, ``flask`` and ``psutil`` in the environment:\n\n.. code-block:: bash\n\n $ pex requests flask 'psutil>2,<3'\n\nSave Dependencies From Pip\n~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nOr instead freeze your current virtualenv via requirements.txt and execute it anywhere:\n\n.. code-block:: bash\n\n $ pex $(pip freeze) -o my_virtualenv.pex\n $ deactivate\n $ ./my_virtualenv.pex\n\nEphemeral Environments\n~~~~~~~~~~~~~~~~~~~~~~\n\nRun webserver.py in an environment containing ``flask`` as a quick way to experiment:\n\n.. code-block:: bash\n\n $ pex flask -- webserver.py\n\nLaunch Sphinx in an ephemeral pex environment using the Sphinx entry point ``sphinx:main``:\n\n.. code-block:: bash\n\n $ pex sphinx -e sphinx:main -- --help\n\nUsing Entry Points\n~~~~~~~~~~~~~~~~~~\n\nProjects specifying a ``console_scripts`` entry point in their configuration\ncan build standalone executables for those entry points.\n\nTo build a standalone ``pex-tools-executable.pex`` binary that runs the\n``pex-tools`` console script found in all pex version ``2.1.35`` and newer distributions:\n\n.. code-block:: bash\n\n $ pex \"pex>=2.1.35\" --console-script pex-tools --output-file pex-tools-executable.pex\n\nSpecifying A Specific Interpreter\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can also build pex files that use a specific interpreter type:\n\n.. code-block:: bash\n\n $ pex \"pex>=2.1.35\" -c pex-tools --python=pypy -o pex-tools-pypy-executable.pex\n\nMost pex options compose well with one another, so the above commands can be\nmixed and matched, and equivalent short options are available.\n\nFor a full list of options, just type ``pex --help``.\n\n\nIntegrating pex into your workflow\n==================================\n\nIf you use tox (and you should!), a simple way to integrate pex into your\nworkflow is to add a packaging test environment to your ``tox.ini``:\n\n.. code-block:: ini\n\n [testenv:package]\n deps = pex\n commands = pex . -o dist/app.pex\n\nThen ``tox -e package`` will produce a relocatable copy of your application\nthat you can copy to staging or production environments.\n\n\nDocumentation\n=============\n\nMore documentation about Pex, building .pex files, and how .pex files work\nis available at https://docs.pex-tool.org.\n\n\nDevelopment\n===========\n\nPex uses `tox <https://tox.wiki/en/latest/>`_ for test and development automation. To run\nthe test suite, just invoke tox:\n\n.. code-block:: bash\n\n $ tox\n\nIf you don't have tox, you can generate a pex of tox:\n\n.. code-block::\n\n $ pex tox -c tox -o ~/bin/tox\n\nTox provides many useful commands and options, explained at https://tox.wiki/en/latest/ .\nBelow, we provide some of the most commonly used commands used when working on Pex, but the\ndocs are worth acquainting yourself with to better understand how Tox works and how to do more\nadvanced commands.\n\nTo run a specific environment, identify the name of the environment you'd like to invoke by\nrunning ``tox --listenvs-all``, then invoke like this:\n\n.. code-block::\n\n $ tox -e fmt\n\nTo run MyPy:\n\n.. code-block::\n\n $ tox -e check\n\nAll of our tox test environments allow passthrough arguments, which can be helpful to run\nspecific tests:\n\n.. code-block::\n\n $ tox -e py37-integration -- -k test_reproducible_build\n\nTo run Pex from source, rather than through what is on your PATH, invoke via Python:\n\n.. code-block::\n\n $ python -m pex\n\n",
"bugtrack_url": null,
"license": null,
"summary": "The PEX packaging toolchain.",
"version": "2.27.1",
"project_urls": {
"Changelog": "https://github.com/pex-tool/pex/blob/v2.27.1/CHANGES.md",
"Documentation": "https://docs.pex-tool.org/",
"Download": "https://github.com/pex-tool/pex/releases/download/v2.27.1/pex",
"Homepage": "https://github.com/pex-tool/pex",
"Source": "https://github.com/pex-tool/pex/tree/v2.27.1"
},
"split_keywords": [
"package",
" executable",
" virtualenv",
" lock",
" freeze"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "549da319e533df0d6a936e9361aaf78a6be3db0667bc87059fcd145a1c5337c7",
"md5": "38e90a2162c356456645dd7705232643",
"sha256": "a826d4bcde255ebe4596e22d24c872c654967adca970d7a7bdbc9c3196bc80a7"
},
"downloads": -1,
"filename": "pex-2.27.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "38e90a2162c356456645dd7705232643",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,<3.14,>=2.7",
"size": 3584149,
"upload_time": "2024-12-14T05:32:22",
"upload_time_iso_8601": "2024-12-14T05:32:22.647542Z",
"url": "https://files.pythonhosted.org/packages/54/9d/a319e533df0d6a936e9361aaf78a6be3db0667bc87059fcd145a1c5337c7/pex-2.27.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b55914d3b17874f9960f66d3f914cbce2a1ef3dab487df3e36d419c124934c1",
"md5": "c107a0342388280585441445c3e6408e",
"sha256": "b54aade2ef6d9180325418c7c34001b966c14a5a36f051c418658fa15cbb564e"
},
"downloads": -1,
"filename": "pex-2.27.1.tar.gz",
"has_sig": false,
"md5_digest": "c107a0342388280585441445c3e6408e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,<3.14,>=2.7",
"size": 4565731,
"upload_time": "2024-12-14T05:32:26",
"upload_time_iso_8601": "2024-12-14T05:32:26.454762Z",
"url": "https://files.pythonhosted.org/packages/6b/55/914d3b17874f9960f66d3f914cbce2a1ef3dab487df3e36d419c124934c1/pex-2.27.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-14 05:32:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pex-tool",
"github_project": "pex",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pex"
}
JSON
