Pillow/docs/index.rst

Pillow
======

Pillow is the friendly PIL fork by `Alex Clark and Contributors <https://github.com/python-pillow/Pillow/graphs/contributors>`_. PIL is the Python Imaging Library by Fredrik Lundh and Contributors.

Pillow for enterprise is available via the Tidelift Subscription. `Learn more <https://tidelift.com/subscription/pkg/pypi-pillow?utm_source=pypi-pillow&utm_medium=docs&utm_campaign=enterprise>`_.

.. image:: https://readthedocs.org/projects/pillow/badge/?version=latest
   :target: https://pillow.readthedocs.io/?badge=latest
   :alt: Documentation Status

.. image:: https://github.com/python-pillow/Pillow/workflows/Lint/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions/workflows/lint.yml
   :alt: GitHub Actions build status (Lint)

.. image:: https://github.com/python-pillow/Pillow/workflows/Test%20Docker/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions/workflows/test-docker.yml
   :alt: GitHub Actions build status (Test Docker)

.. image:: https://github.com/python-pillow/Pillow/workflows/Test/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions/workflows/test.yml
   :alt: GitHub Actions build status (Test Linux and macOS)

.. image:: https://github.com/python-pillow/Pillow/workflows/Test%20Windows/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions/workflows/test-windows.yml
   :alt: GitHub Actions build status (Test Windows)

.. image:: https://github.com/python-pillow/Pillow/workflows/Test%20MinGW/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions/workflows/test-mingw.yml
   :alt: GitHub Actions build status (Test MinGW)

.. image:: https://github.com/python-pillow/Pillow/workflows/Test%20Cygwin/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions/workflows/test-cygwin.yml
   :alt: GitHub Actions build status (Test Cygwin)

.. image:: https://img.shields.io/appveyor/build/python-pillow/Pillow/main.svg?label=Windows%20build
   :target: https://ci.appveyor.com/project/python-pillow/Pillow
   :alt: AppVeyor CI build status (Windows)

.. image:: https://github.com/python-pillow/pillow-wheels/workflows/Wheels/badge.svg
   :target: https://github.com/python-pillow/pillow-wheels/actions
   :alt: GitHub Actions wheels build status (Wheels)

.. image:: https://img.shields.io/travis/com/python-pillow/pillow-wheels/main.svg?label=aarch64%20wheels
   :target: https://app.travis-ci.com/github/python-pillow/pillow-wheels
   :alt: Travis CI wheels build status (aarch64)

.. image:: https://codecov.io/gh/python-pillow/Pillow/branch/main/graph/badge.svg
   :target: https://app.codecov.io/gh/python-pillow/Pillow
   :alt: Code coverage

.. image:: https://zenodo.org/badge/17549/python-pillow/Pillow.svg
   :target: https://zenodo.org/badge/latestdoi/17549/python-pillow/Pillow
   :alt: Zenodo

.. image:: https://tidelift.com/badges/package/pypi/Pillow?style=flat
   :target: https://tidelift.com/subscription/pkg/pypi-pillow?utm_source=pypi-pillow&utm_medium=badge
   :alt: Tidelift

.. image:: https://github.com/python-pillow/Pillow/actions/workflows/tidelift.yml/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions/workflows/tidelift.yml
   :alt: Tidelift Align

.. image:: https://oss-fuzz-build-logs.storage.googleapis.com/badges/pillow.svg
   :target: https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:pillow
   :alt: Fuzzing Status

.. image:: https://img.shields.io/pypi/v/pillow.svg
   :target: https://pypi.org/project/Pillow/
   :alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/dm/pillow.svg
   :target: https://pypi.org/project/Pillow/
   :alt: Number of PyPI downloads

.. image:: https://bestpractices.coreinfrastructure.org/projects/6331/badge
   :target: https://bestpractices.coreinfrastructure.org/projects/6331
   :alt: OpenSSF Best Practices

Overview
========

The Python Imaging Library adds image processing capabilities to your Python interpreter.

This library provides extensive file format support, an efficient internal representation, and fairly powerful image processing capabilities.

The core image library is designed for fast access to data stored in a few basic pixel formats. It should provide a solid foundation for a general image processing tool.

.. toctree::
   :maxdepth: 2

   installation.rst
   handbook/index.rst
   reference/index.rst
   porting.rst
   about.rst
   releasenotes/index.rst
   deprecations.rst

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
Fix alt text [ci skip] 2014-04-09 11:40:16 +04:00			`Pillow`
Wording 2014-03-18 00:57:03 +04:00			`======`
Fresh start for docs, generated by sphinx-apidoc 2013-04-12 21:52:50 +04:00
Wording [ci skip] Remove comments on "friendly PIL fork" 2015-09-29 16:53:07 +03:00			Pillow is the friendly PIL fork by `Alex Clark and Contributors <https://github.com/python-pillow/Pillow/graphs/contributors>`_. PIL is the Python Imaging Library by Fredrik Lundh and Contributors.
Add some main page info 2013-10-07 09:49:20 +04:00
Update Tidelift UTM params [ci skip] 2020-03-31 20:25:01 +03:00			Pillow for enterprise is available via the Tidelift Subscription. `Learn more <https://tidelift.com/subscription/pkg/pypi-pillow?utm_source=pypi-pillow&utm_medium=docs&utm_campaign=enterprise>`_.
Added Tidelift Subscription link [ci skip] 2019-09-05 12:31:55 +03:00
Add docs badge [ci skip] Because more badges and the same badges duplicated in two places! (Maybe we only need badges in either the README.rst or docs/index.rst? Or maybe just we need to keep duplicating them. Not sure.) 2015-10-02 03:17:48 +03:00			`.. image:: https://readthedocs.org/projects/pillow/badge/?version=latest`
Update RTD links https://blog.readthedocs.com/securing-subdomains/ 2016-04-28 09:35:03 +03:00			`:target: https://pillow.readthedocs.io/?badge=latest`
Add docs badge [ci skip] Because more badges and the same badges duplicated in two places! (Maybe we only need badges in either the README.rst or docs/index.rst? Or maybe just we need to keep duplicating them. Not sure.) 2015-10-02 03:17:48 +03:00			`:alt: Documentation Status`

Changed docs badges to be closer to README badges [ci skip] 2020-02-15 09:41:50 +03:00			`.. image:: https://github.com/python-pillow/Pillow/workflows/Lint/badge.svg`
Link directly to workflow pages 2022-01-28 03:23:51 +03:00			`:target: https://github.com/python-pillow/Pillow/actions/workflows/lint.yml`
Changed docs badges to be closer to README badges [ci skip] 2020-02-15 09:41:50 +03:00			`:alt: GitHub Actions build status (Lint)`

			`.. image:: https://github.com/python-pillow/Pillow/workflows/Test%20Docker/badge.svg`
Link directly to workflow pages 2022-01-28 03:23:51 +03:00			`:target: https://github.com/python-pillow/Pillow/actions/workflows/test-docker.yml`
Changed docs badges to be closer to README badges [ci skip] 2020-02-15 09:41:50 +03:00			`:alt: GitHub Actions build status (Test Docker)`

			`.. image:: https://github.com/python-pillow/Pillow/workflows/Test/badge.svg`
Link directly to workflow pages 2022-01-28 03:23:51 +03:00			`:target: https://github.com/python-pillow/Pillow/actions/workflows/test.yml`
Changed docs badges to be closer to README badges [ci skip] 2020-02-15 09:41:50 +03:00			`:alt: GitHub Actions build status (Test Linux and macOS)`

			`.. image:: https://github.com/python-pillow/Pillow/workflows/Test%20Windows/badge.svg`
Link directly to workflow pages 2022-01-28 03:23:51 +03:00			`:target: https://github.com/python-pillow/Pillow/actions/workflows/test-windows.yml`
Changed docs badges to be closer to README badges [ci skip] 2020-02-15 09:41:50 +03:00			`:alt: GitHub Actions build status (Test Windows)`

Added MinGW GitHub Actions badge 2022-01-28 03:25:24 +03:00			`.. image:: https://github.com/python-pillow/Pillow/workflows/Test%20MinGW/badge.svg`
			`:target: https://github.com/python-pillow/Pillow/actions/workflows/test-mingw.yml`
			`:alt: GitHub Actions build status (Test MinGW)`

Added Cygwin badge 2022-05-08 14:40:46 +03:00			`.. image:: https://github.com/python-pillow/Pillow/workflows/Test%20Cygwin/badge.svg`
			`:target: https://github.com/python-pillow/Pillow/actions/workflows/test-cygwin.yml`
			`:alt: GitHub Actions build status (Test Cygwin)`

Rename master to main 2021-10-15 17:30:05 +03:00			`.. image:: https://img.shields.io/appveyor/build/python-pillow/Pillow/main.svg?label=Windows%20build`
Remove old Travis CI config 2020-12-14 21:35:04 +03:00			`:target: https://ci.appveyor.com/project/python-pillow/Pillow`
			`:alt: AppVeyor CI build status (Windows)`

Updated badges for wheels 2021-05-10 15:11:22 +03:00			`.. image:: https://github.com/python-pillow/pillow-wheels/workflows/Wheels/badge.svg`
			`:target: https://github.com/python-pillow/pillow-wheels/actions`
			`:alt: GitHub Actions wheels build status (Wheels)`

Rename master to main 2021-10-15 17:30:05 +03:00			`.. image:: https://img.shields.io/travis/com/python-pillow/pillow-wheels/main.svg?label=aarch64%20wheels`
Updated links 2022-01-18 06:26:52 +03:00			`:target: https://app.travis-ci.com/github/python-pillow/pillow-wheels`
Updated badges for wheels 2021-05-10 15:11:22 +03:00			`:alt: Travis CI wheels build status (aarch64)`
Remove old Travis CI config 2020-12-14 21:35:04 +03:00
Rename master to main 2021-10-15 17:30:05 +03:00			`.. image:: https://codecov.io/gh/python-pillow/Pillow/branch/main/graph/badge.svg`
Updated links 2022-01-18 06:26:52 +03:00			`:target: https://app.codecov.io/gh/python-pillow/Pillow`
Changed docs badges to be closer to README badges [ci skip] 2020-02-15 09:41:50 +03:00			`:alt: Code coverage`

			`.. image:: https://zenodo.org/badge/17549/python-pillow/Pillow.svg`
			`:target: https://zenodo.org/badge/latestdoi/17549/python-pillow/Pillow`
			`:alt: Zenodo`

			`.. image:: https://tidelift.com/badges/package/pypi/Pillow?style=flat`
Update Tidelift UTM params [ci skip] 2020-03-31 20:25:01 +03:00			`:target: https://tidelift.com/subscription/pkg/pypi-pillow?utm_source=pypi-pillow&utm_medium=badge`
Changed docs badges to be closer to README badges [ci skip] 2020-02-15 09:41:50 +03:00			`:alt: Tidelift`

Added Tidelift Align badge to docs 2021-10-19 09:07:55 +03:00			`.. image:: https://github.com/python-pillow/Pillow/actions/workflows/tidelift.yml/badge.svg`
			`:target: https://github.com/python-pillow/Pillow/actions/workflows/tidelift.yml`
			`:alt: Tidelift Align`

Added oss-fuzz badge 2022-11-04 13:32:40 +03:00			`.. image:: https://oss-fuzz-build-logs.storage.googleapis.com/badges/pillow.svg`
			`:target: https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:pillow`
			`:alt: Fuzzing Status`

Shields.io badges instead of broken pypip.in. PNG->SVG for consistency [CI skip] 2015-06-08 15:02:28 +03:00			`.. image:: https://img.shields.io/pypi/v/pillow.svg`
Update links to new PyPI 2018-04-17 17:06:43 +03:00			`:target: https://pypi.org/project/Pillow/`
Updated redirected URL 2016-01-09 02:43:11 +03:00			`:alt: Latest PyPI version`
Copy/move a bunch of README content to the doc site 2013-10-09 04:13:06 +04:00
Revert "Remove broken downloads badge" This reverts commit 45cbd2566470890bd5bc2fe20c4257f5e1a0d981. 2018-10-29 17:11:42 +03:00			`.. image:: https://img.shields.io/pypi/dm/pillow.svg`
Updated redirected URL 2018-12-14 16:05:35 +03:00			`:target: https://pypi.org/project/Pillow/`
Revert "Remove broken downloads badge" This reverts commit 45cbd2566470890bd5bc2fe20c4257f5e1a0d981. 2018-10-29 17:11:42 +03:00			`:alt: Number of PyPI downloads`

Add OpenSSF Best Practices badge 2022-09-19 10:36:46 +03:00			`.. image:: https://bestpractices.coreinfrastructure.org/projects/6331/badge`
			`:target: https://bestpractices.coreinfrastructure.org/projects/6331`
			`:alt: OpenSSF Best Practices`

Added overview [ci skip] 2020-09-24 01:33:52 +03:00			`Overview`
			`========`

			`The Python Imaging Library adds image processing capabilities to your Python interpreter.`

			`This library provides extensive file format support, an efficient internal representation, and fairly powerful image processing capabilities.`

			`The core image library is designed for fast access to data stored in a few basic pixel formats. It should provide a solid foundation for a general image processing tool.`

Fresh start for docs, generated by sphinx-apidoc 2013-04-12 21:52:50 +04:00			`.. toctree::`
Decrease ToC max depth to 2 2013-10-07 08:14:41 +04:00			`:maxdepth: 2`
Fresh start for docs, generated by sphinx-apidoc 2013-04-12 21:52:50 +04:00
Shorten title; Clarify these are rst files - Shorten "About Pillow" to Pillow (the reader likely already knows we're talking about Pillow) - Clarify reference to rst files by using rst extension; Sphinx seems to recognize either convention, but humans (like me) forget exactly what Sphinx is doing sometimes. 2015-09-30 13:21:52 +03:00			`installation.rst`
Clean up Handbook A while back somebody awesome forked the PIL Handbook (http://effbot.org/imagingbook/pil-index.htm) to Pillow. IIRC we tried to incorporate the handbook "seemlessly", which apparently meant not using the word "handbook" anywhere. Now that seems confusing, so I'm reorganizing all the handbook content under one section named "Handbook". This commit: - Moves guides.rst to handbook/index.rst - Moves appendices.rst to handbook/ - Removes developer.rst from handbook index. - Removes porting-pil-to-pillow.rst from handbook index. Unrelated to the above: - Shorten title "Porting existing PIL-based code to Pillow" to "Porting" - Move text "Porting existing PIL-based code to Pillow" to faux sub-header (bold text not sub-header because there's only one section.) "Porting" may be better named "Migrating", not sure yet. 2015-09-30 13:38:51 +03:00			`handbook/index.rst`
Fully document PIL.Image from handbook 2013-10-12 09:18:28 +04:00			`reference/index.rst`
Order swap and remove old ref 2015-09-30 14:33:16 +03:00			`porting.rst`
Shorten title; Clarify these are rst files - Shorten "About Pillow" to Pillow (the reader likely already knows we're talking about Pillow) - Clarify reference to rst files by using rst extension; Sphinx seems to recognize either convention, but humans (like me) forget exactly what Sphinx is doing sometimes. 2015-09-30 13:21:52 +03:00			`about.rst`
Ordering & remove plugins [ci skip] Ordering & remove plugins from list (moved to reference folder) 2015-10-01 18:02:56 +03:00			`releasenotes/index.rst`
Add deprecations and removals page to docs 2018-12-06 11:56:07 +03:00			`deprecations.rst`
Copy/move a bunch of README content to the doc site 2013-10-09 04:13:06 +04:00
Fresh start for docs, generated by sphinx-apidoc 2013-04-12 21:52:50 +04:00			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`