Skip to content

Build docs #1017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugovk merged 2 commits into from
Nov 19, 2014
Merged

Build docs #1017

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c85d44
Build Options section [ci skip]
wiredfool Nov 19, 2014
d825c76
Updated Test/Support Matrix [ci skip]
wiredfool Nov 19, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 40 additions & 13 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ Many of Pillow's features require external libraries:

* **libjpeg** provides JPEG functionality.

* Pillow has been tested with libjpeg versions **6b**, **8**, and **9**
* Pillow has been tested with libjpeg versions **6b**, **8**, and **9** and libjpeg-turbo version **8**.

* **zlib** provides access to compressed PNGs

* **libtiff** provides group4 tiff functionality
* **libtiff** provides compressed TIFF functionality

* Pillow has been tested with libtiff versions **3.x** and **4.0**

Expand Down Expand Up @@ -93,6 +93,35 @@ line::

$ CFLAGS="-I/usr/pkg/include" pip install pillow

Build Options
-------------

* Environment Variable: ``MAX_CONCURRENCY=n``. By default, Pillow will
use multiprocessing to build the extension in parallel. This may not
be ideal for machines that report a large number of cores compared
to the actual processor power. Set ``MAX_CONCURRENCY`` to 1 to disable
parallel building, or to a larger number to limit to that number of
parallel tasks.

* Build flags: ``--disable-zlib``, ``--disable-jpeg``,
``--disable-tiff``, ``--disable-freetype``, ``--disable-tcl``,
``--disable-tk``, ``--disable-lcms``, ``--disable-webp``,
``--disable-webpmux``, ``--disable-jpeg2000``. Disable building the
corresponding feature even if the development libraries are present
on the building machine.

* Build flags: ``--enable-zlib``, ``--enable-jpeg``,
``--enable-tiff``, ``--enable-freetype``, ``--enable-tcl``,
``--enable-tk``, ``--enable-lcms``, ``--enable-webp``,
``--enable-webpmux``, ``--enable-jpeg2000``. Require that the
corresponding feature is built. The build will raise an exception if
the libraries are not found. Webpmux (WebP metadata) relies on WebP
support. Tcl and Tk also must be used together.

Sample Usage::

$ MAX_CONCURRENCY=1 python setup.py build-ext --enable-[feature] install


Linux installation
------------------
Expand All @@ -116,11 +145,6 @@ In Fedora, the command is::

$ sudo yum install python-devel

Prerequisites are installed on **Ubuntu 10.04 LTS** with::

$ sudo apt-get install libtiff4-dev libjpeg62-dev zlib1g-dev \
libfreetype6-dev tcl8.5-dev tk8.5-dev python-tk

Prerequisites are installed on **Ubuntu 12.04 LTS** or **Raspian Wheezy
7.0** with::

Expand Down Expand Up @@ -184,7 +208,7 @@ to a specific version:

::

$ pip install --use-wheel Pillow==2.3.0
$ pip install --use-wheel Pillow==2.6.1

FreeBSD installation
---------------------
Expand Down Expand Up @@ -222,9 +246,11 @@ current versions of Linux, OS X, and Windows.
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
|**Operating system** |**Supported**|**Tested Python versions** |**Tested Pillow versions** |**Tested processors** |
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
| Mac OS X 10.8 Mountain Lion |Yes | 2.6,2.7,3.2,3.3 | |x86-64 |
| Mac OS X 10.10 Yosemite | | | |x86-64 |
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
| Mac OS X 10.7 Lion |Yes | 2.6,2.7,3.2,3.3 | 2.2.0 |x86-64 |
| Mac OS X 10.9 Mavericks |Yes | 2.7,3.4 | 2.6.1 |x86-64 |
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
| Mac OS X 10.8 Mountain Lion |Yes | 2.6,2.7,3.2,3.3 | |x86-64 |
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
| Redhat Linux 6 |Yes | 2.6 | |x86 |
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
Expand All @@ -234,11 +260,12 @@ current versions of Linux, OS X, and Windows.
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
| Ubuntu Linux 10.04 LTS |Yes | 2.6 | 2.3.0 |x86,x86-64 |
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
| Ubuntu Linux 12.04 LTS |Yes | 2.6,2.7,3.2,3.3,PyPy2.1 | 2.3.0 |x86,x86-64 |
| Ubuntu Linux 12.04 LTS |Yes | 2.6,2.7,3.2,3.3,PyPy2.4, | 2.6.1 |x86,x86-64 |
| | | PyPy3,v2.3 | | |
| | | | | |
| | | 2.7,3.2 | 2.3.0 |ppc |
| | | 2.7,3.2 | 2.6.1 |ppc |
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
| Ubuntu Linux 13.10 |Yes | 2.7,3.2,3.3 | 2.3.0 |x86 |
| Ubuntu Linux 14.04 LTS |Yes | 2.7,3.2,3.3,3.4 | 2.3.0 |x86 |
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
| Raspian Wheezy |Yes | 2.7,3.2 | 2.3.0 |arm |
+----------------------------------+-------------+------------------------------+------------------------------+-----------------------+
Expand Down