Skip to content

Commit

Permalink
Document packaging types we support
Browse files Browse the repository at this point in the history
Signed-off-by: Bernat Gabor <bgabor8@bloomberg.net>
  • Loading branch information
gaborbernat committed Mar 13, 2020
1 parent 9742921 commit 05dc1ad
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/changelog/1714.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
:ref:`supports <compatibility-requirements>` details now explicitly what Python installations we support
- by :user:`gaborbernat`.
39 changes: 35 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,39 @@ virtualenv works with the following Python interpreter implementations:
- `PyPy <https://pypy.org/>`_ 2.7 and 3.4+.

This means virtualenv works on the latest patch version of each of these minor versions. Previous patch versions are
supported on a best effort approach. virtualenv works on the following platforms:
supported on a best effort approach.

- Unix/Linux,
- macOS,
- Windows.
CPython is shipped in multiple forms, and each OS repackages it, often applying some customization along the way.
Therefore we cannot say universally that we support all platforms, but rather specify some we test against. In case
of ones not specified here the support is unknown, though likely will work. If you find some cases please open a feature
request on our issue tracker.

Linux
~~~~~
- installations from `python.org <https://www.python.org/downloads/>`_
- Ubuntu 16.04+ (both upstream and `deasnakes <https://launchpad.net/~deadsnakes/+archive/ubuntu/ppa>`_ builds)
- Fedora
- RHEL and CentOS
- OpenSuse
- Arch Linux

macOS
~~~~~
In case of macOs we support:
- installations from `python.org <https://www.python.org/downloads/>`_
- python versions installed via `brew <https://docs.brew.sh/Homebrew-and-Python>`_ (both older python2.7 and python3)
- Python 3 part of XCode (Python framework - ``/Library/Frameworks/Python3.framework/``)
- Python 2 part of the OS (``/System/Library/Frameworks/Python.framework/Versions/``)

Windows
~~~~~~~
- Installations from `python.org <https://www.python.org/downloads/>`_
- Windows Store Python - note only `version 3.8+ <https://www.microsoft.com/en-us/p/python-38/9mssztt1n39l>`_ (``3.7``
was marked experimental and contains many bugs that would make it very hard for us to support it)

Packaging variants
~~~~~~~~~~~~~~~~~~
- Normal variant (file structure as comes from `python.org <https://www.python.org/downloads/>`_).
- We support system installations that do not contain the python files for the standard library if the respective
compiled files are present (e.g. only ``os.pyc``, not ``os.py``) - relevant mostly for ``Python 2.7``. This can be
used by custom systems may want to maximize available storage or obfuscate source code by removing ``.py`` files.

0 comments on commit 05dc1ad

Please sign in to comment.