https://github.com/databricks/pex
Fork of pantsbuild/pex with a few Databricks-specific changes
https://github.com/databricks/pex
Last synced: 6 months ago
JSON representation
Fork of pantsbuild/pex with a few Databricks-specific changes
- Host: GitHub
- URL: https://github.com/databricks/pex
- Owner: databricks
- License: apache-2.0
- Created: 2016-02-29T18:46:21.000Z (almost 10 years ago)
- Default Branch: databricks
- Last Pushed: 2024-10-14T15:19:45.000Z (over 1 year ago)
- Last Synced: 2025-04-03T00:58:59.883Z (11 months ago)
- Language: Python
- Homepage:
- Size: 1.85 MB
- Stars: 3
- Watchers: 309
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
PEX
===
.. image:: https://travis-ci.org/pantsbuild/pex.svg?branch=master
:target: https://travis-ci.org/pantsbuild/pex
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
.. code-block:: bash
$ pip install pex
You can also build pex in a git clone using tox:
.. code-block:: bash
$ tox -e py27-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'
Or instead freeze your current virtualenv via requirements.txt and execute it anywhere:
.. code-block:: bash
$ pex -r <(pip freeze) -o my_virtualenv.pex
$ deactivate
$ ./my_virtualenv.pex
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
Build a standalone pex binary into ``pex.pex`` using the ``pex`` console_scripts entry point:
.. code-block:: bash
$ pex pex -c pex -o pex.pex
You can also build pex files that use a specific interpreter type:
.. code-block:: bash
$ pex pex -c pex --python=pypy -o pypy-pex.pex
Most pex options compose well with one another, so the above commands can be
mixed and matched. 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 relocateable 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:
.. 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
Contributing
============
To contribute, follow these instructions: http://pantsbuild.org/howto_contribute.html