Pillow/README.rst

Pillow
======

Python Imaging Library (Fork)
-----------------------------

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. As of 2019, Pillow development is `supported by Tidelift <https://tidelift.com/subscription/pkg/pypi-pillow>`_.

.. start-badges

.. list-table::
    :stub-columns: 1

    * - docs
      - |docs|
    * - tests
      - |linux| |macos| |windows| |gha_lint| |gha| |gha_windows| |gha_docker| |coverage|
    * - package
      - |zenodo| |tidelift| |version| |downloads|
    * - social
      - |gitter| |twitter|

.. end-badges

More Information
----------------

- `Documentation <https://pillow.readthedocs.io/>`_

  - `Installation <https://pillow.readthedocs.io/en/latest/installation.html>`_
  - `Handbook <https://pillow.readthedocs.io/en/latest/handbook/index.html>`_

- `Contribute <https://github.com/python-pillow/Pillow/blob/master/.github/CONTRIBUTING.md>`_

  - `Issues <https://github.com/python-pillow/Pillow/issues>`_
  - `Pull requests <https://github.com/python-pillow/Pillow/pulls>`_

- `Changelog <https://github.com/python-pillow/Pillow/blob/master/CHANGES.rst>`_

  - `Pre-fork <https://github.com/python-pillow/Pillow/blob/master/CHANGES.rst#pre-fork>`_

Report a Vulnerability
----------------------

To report a security vulnerability, please follow the procedure described in the `Tidelift security policy <https://tidelift.com/docs/security>`_.

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

.. |linux| image:: https://img.shields.io/travis/python-pillow/Pillow/master.svg?label=Linux%20build
   :target: https://travis-ci.org/python-pillow/Pillow
   :alt: Travis CI build status (Linux)

.. |macos| image:: https://img.shields.io/travis/python-pillow/pillow-wheels/master.svg?label=macOS%20build
   :target: https://travis-ci.org/python-pillow/pillow-wheels
   :alt: Travis CI build status (macOS)

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

.. |gha_lint| image:: https://github.com/python-pillow/Pillow/workflows/Lint/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions?query=workflow%3ALint
   :alt: GitHub Actions build status (Lint)

.. |gha_docker| image:: https://github.com/python-pillow/Pillow/workflows/Test%20Docker/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions?query=workflow%3A%22Test+Docker%22
   :alt: GitHub Actions build status (Test Docker)

.. |gha| image:: https://github.com/python-pillow/Pillow/workflows/Test/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions?query=workflow%3ATest
   :alt: GitHub Actions build status (Test Linux and macOS)

.. |gha_windows| image:: https://github.com/python-pillow/Pillow/workflows/Test%20Windows/badge.svg
   :target: https://github.com/python-pillow/Pillow/actions?query=workflow%3A%22Test+Windows%22
   :alt: GitHub Actions build status (Test Windows)

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

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

.. |tidelift| image:: https://tidelift.com/badges/package/pypi/Pillow?style=flat
   :target: https://tidelift.com/subscription/pkg/pypi-pillow?utm_source=pypi-pillow&utm_medium=referral&utm_campaign=readme

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

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

.. |gitter| image:: https://badges.gitter.im/python-pillow/Pillow.svg
   :target: https://gitter.im/python-pillow/Pillow?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
   :alt: Join the chat at https://gitter.im/python-pillow/Pillow

.. |twitter| image:: https://img.shields.io/badge/tweet-on%20Twitter-00aced.svg
   :target: https://twitter.com/PythonPillow
   :alt: Follow on https://twitter.com/PythonPillow
Removed feline quality typing 2013-06-14 08:20:46 +04:00			`Pillow`
Forking PIL 2010-07-31 06:52:47 +04:00			`======`

Jazz up README [ci skip] I've not liked the "plain" readme for the last few releases, so I've adjusted things hopefully for the better: - Rename/add section headers - Divide content into two sections - Provide bulleted list with most important links e.g. "install" 2015-03-25 01:23:55 +03:00			`Python Imaging Library (Fork)`
			`-----------------------------`
Wording [ci skip] 2013-10-02 15:06:12 +04:00
Add info to README re: Tidelift [ci skip] Link to https://tidelift.com/subscription/pkg/pypi-pillow 2019-05-11 21:33:54 +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. As of 2019, Pillow development is `supported by Tidelift <https://tidelift.com/subscription/pkg/pypi-pillow>`_.
Wording 2013-06-30 03:30:52 +04:00
Tabulate badges Inspired by https://github.com/pytest-dev/pytest-cov/blob/master/README.rst [CI skip] 2016-04-04 18:25:31 +03:00			`.. start-badges`

			`.. list-table::`
			`:stub-columns: 1`
Add Zenodo badge for #1322 [ci skip] Looks like I had to "draft a release" in the GitHub UI to make this work. 2015-10-06 21:37:27 +03:00
Tabulate badges Inspired by https://github.com/pytest-dev/pytest-cov/blob/master/README.rst [CI skip] 2016-04-04 18:25:31 +03:00			`* - docs`
			`- \|docs\|`
			`* - tests`
Rearranged badges [ci skip] Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com> 2019-10-12 13:53:49 +03:00			`- \|linux\| \|macos\| \|windows\| \|gha_lint\| \|gha\| \|gha_windows\| \|gha_docker\| \|coverage\|`
Tabulate badges Inspired by https://github.com/pytest-dev/pytest-cov/blob/master/README.rst [CI skip] 2016-04-04 18:25:31 +03:00			`* - package`
Added Tidelift badge 2018-12-25 05:11:11 +03:00			`- \|zenodo\| \|tidelift\| \|version\| \|downloads\|`
Add Twitter badge 2018-01-04 13:09:01 +03:00			`* - social`
			`- \|gitter\| \|twitter\|`
Tabulate badges Inspired by https://github.com/pytest-dev/pytest-cov/blob/master/README.rst [CI skip] 2016-04-04 18:25:31 +03:00
Move badge links to the bottom 2019-03-25 01:00:12 +03:00			`.. end-badges`

			`More Information`
			`----------------`

			- `Documentation <https://pillow.readthedocs.io/>`_

			- `Installation <https://pillow.readthedocs.io/en/latest/installation.html>`_
			- `Handbook <https://pillow.readthedocs.io/en/latest/handbook/index.html>`_

			- `Contribute <https://github.com/python-pillow/Pillow/blob/master/.github/CONTRIBUTING.md>`_

			- `Issues <https://github.com/python-pillow/Pillow/issues>`_
			- `Pull requests <https://github.com/python-pillow/Pillow/pulls>`_

			- `Changelog <https://github.com/python-pillow/Pillow/blob/master/CHANGES.rst>`_

			- `Pre-fork <https://github.com/python-pillow/Pillow/blob/master/CHANGES.rst#pre-fork>`_

Copy setuptools' security vulnerability text Thanks! https://github.com/pypa/setuptools/blob/master/README.rst 2019-03-25 01:02:55 +03:00			`Report a Vulnerability`
			`----------------------`

Linking 2019-03-25 01:15:10 +03:00			To report a security vulnerability, please follow the procedure described in the `Tidelift security policy <https://tidelift.com/docs/security>`_.
Copy setuptools' security vulnerability text Thanks! https://github.com/pypa/setuptools/blob/master/README.rst 2019-03-25 01:02:55 +03:00
Tabulate badges Inspired by https://github.com/pytest-dev/pytest-cov/blob/master/README.rst [CI skip] 2016-04-04 18:25:31 +03:00			`.. \|docs\| 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! 2015-10-02 03:10:15 +03:00			`:alt: Documentation Status`

Tabulate badges Inspired by https://github.com/pytest-dev/pytest-cov/blob/master/README.rst [CI skip] 2016-04-04 18:25:31 +03:00			`.. \|linux\| image:: https://img.shields.io/travis/python-pillow/Pillow/master.svg?label=Linux%20build`
Fix Travis CI badge for new python-pillow name 2014-06-03 12:06:27 +04:00			`:target: https://travis-ci.org/python-pillow/Pillow`
Add OS X build badge [CI skip] We have OS X builds in another repo. Show the badge here too, to help spot OS X build breaks sooner (for example, if might pass on Linux). 2015-03-06 11:52:10 +03:00			`:alt: Travis CI build status (Linux)`
Move image 2013-03-07 02:55:43 +04:00
Changed pillow-wheels badge branch to master 2018-12-12 23:27:30 +03:00			`.. \|macos\| image:: https://img.shields.io/travis/python-pillow/pillow-wheels/master.svg?label=macOS%20build`
Reinstate OS X badge [CI skip] 2015-06-08 16:12:28 +03:00			`:target: https://travis-ci.org/python-pillow/pillow-wheels`
Renamed references to OS X to macOS 2016-09-23 14:12:03 +03:00			`:alt: Travis CI build status (macOS)`
Reinstate OS X badge [CI skip] 2015-06-08 16:12:28 +03:00
Updated redirected URL 2020-02-08 03:54:57 +03:00			`.. \|windows\| image:: https://img.shields.io/appveyor/build/python-pillow/Pillow/master.svg?label=Windows%20build`
Update AppVeyor URL accordingly [ci skip] c.f. #1468 2015-10-04 22:41:14 +03:00			`:target: https://ci.appveyor.com/project/python-pillow/Pillow`
Fix alt text [CI skip] 2015-06-18 22:05:15 +03:00			`:alt: AppVeyor CI build status (Windows)`
Add AppVeyor badge [CI skip] Docs: http://www.appveyor.com/docs/status-badges TODO Change to master branch when available. 2015-06-18 22:02:22 +03:00
Added GitHub Actions badges [ci skip] 2019-10-11 14:04:21 +03:00			`.. \|gha_lint\| image:: https://github.com/python-pillow/Pillow/workflows/Lint/badge.svg`
Added GitHub Actions links to badges [ci skip] 2020-02-15 02:58:04 +03:00			`:target: https://github.com/python-pillow/Pillow/actions?query=workflow%3ALint`
Added GitHub Actions badges [ci skip] 2019-10-11 14:04:21 +03:00			`:alt: GitHub Actions build status (Lint)`

			`.. \|gha_docker\| image:: https://github.com/python-pillow/Pillow/workflows/Test%20Docker/badge.svg`
Added GitHub Actions links to badges [ci skip] 2020-02-15 02:58:04 +03:00			`:target: https://github.com/python-pillow/Pillow/actions?query=workflow%3A%22Test+Docker%22`
Added GitHub Actions badges [ci skip] 2019-10-11 14:04:21 +03:00			`:alt: GitHub Actions build status (Test Docker)`

Added GitHub Actions badges for platform builds [ci skip] 2019-10-12 13:38:01 +03:00			`.. \|gha\| image:: https://github.com/python-pillow/Pillow/workflows/Test/badge.svg`
Added GitHub Actions links to badges [ci skip] 2020-02-15 02:58:04 +03:00			`:target: https://github.com/python-pillow/Pillow/actions?query=workflow%3ATest`
Added GitHub Actions badges for platform builds [ci skip] 2019-10-12 13:38:01 +03:00			`:alt: GitHub Actions build status (Test Linux and macOS)`

			`.. \|gha_windows\| image:: https://github.com/python-pillow/Pillow/workflows/Test%20Windows/badge.svg`
Added GitHub Actions links to badges [ci skip] 2020-02-15 02:58:04 +03:00			`:target: https://github.com/python-pillow/Pillow/actions?query=workflow%3A%22Test+Windows%22`
Added GitHub Actions badges for platform builds [ci skip] 2019-10-12 13:38:01 +03:00			`:alt: GitHub Actions build status (Test Windows)`

Link to Codecov rather than Coveralls 2019-02-07 18:47:20 +03:00			`.. \|coverage\| image:: https://codecov.io/gh/python-pillow/Pillow/branch/master/graph/badge.svg`
			`:target: https://codecov.io/gh/python-pillow/Pillow`
Tabulate badges Inspired by https://github.com/pytest-dev/pytest-cov/blob/master/README.rst [CI skip] 2016-04-04 18:25:31 +03:00			`:alt: Code coverage`

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

Update Tidelift badge See https://forum.tidelift.com/t/new-urls-for-project-badges/288 2019-09-07 12:46:33 +03:00			`.. \|tidelift\| image:: https://tidelift.com/badges/package/pypi/Pillow?style=flat`
Added Tidelift badge 2018-12-25 05:11:11 +03:00			`:target: https://tidelift.com/subscription/pkg/pypi-pillow?utm_source=pypi-pillow&utm_medium=referral&utm_campaign=readme`

Tabulate badges Inspired by https://github.com/pytest-dev/pytest-cov/blob/master/README.rst [CI skip] 2016-04-04 18:25:31 +03:00			`.. \|version\| 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/`
Shields.io badges instead of broken pypip.in. PNG->SVG for consistency [CI skip] 2015-06-08 15:02:28 +03:00			`:alt: Latest PyPI version`
Add PyPI badges! http://codeinthehole.com/writing/pypi-readme-badges/ 2013-10-06 19:22:41 +04:00
Revert "Comment out broken PyPI downloads badge" This reverts commit 5364abbae3c693bbb16d3844ac9b05be3e6c7bba. 2018-10-29 17:15:21 +03:00			`.. \|downloads\| 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 "Comment out broken PyPI downloads badge" This reverts commit 5364abbae3c693bbb16d3844ac9b05be3e6c7bba. 2018-10-29 17:15:21 +03:00			`:alt: Number of PyPI downloads`

Fixed typos [ci skip] 2017-12-15 11:52:42 +03:00			`.. \|gitter\| image:: https://badges.gitter.im/python-pillow/Pillow.svg`
moved glitter badge 2017-12-13 14:53:38 +03:00			`:target: https://gitter.im/python-pillow/Pillow?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge`
			`:alt: Join the chat at https://gitter.im/python-pillow/Pillow`

Add Twitter badge 2018-01-04 13:09:01 +03:00			`.. \|twitter\| image:: https://img.shields.io/badge/tweet-on%20Twitter-00aced.svg`
			`:target: https://twitter.com/PythonPillow`
			`:alt: Follow on https://twitter.com/PythonPillow`