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.

.. 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)

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

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

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

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

.. image:: https://coveralls.io/repos/python-pillow/Pillow/badge.svg?branch=master&service=github
   :target: https://coveralls.io/r/python-pillow/Pillow?branch=master
   :alt: Code coverage

.. image:: https://landscape.io/github/python-pillow/Pillow/master/landscape.svg
   :target: https://landscape.io/github/python-pillow/Pillow/master
   :alt: Code health

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

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

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

- `Contribute <https://github.com/python-pillow/Pillow/blob/master/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>`_
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
README fixes - Add Makefile target ``make readme`` to run ``viewdoc`` - Reorg "More Info" sections - Docs to the top - Less doc links (folks can find more than installation & guides from documentation link) - Add link to PRs - Reorg link to pre-fork changes 2015-09-29 13:35: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.
Wording 2013-06-30 03:30:52 +04:00
Clarify build badges [Ci skip] Three "build: passing" badges in a row looks a bit odd. AppVeyor allows you to customise the right-hand side text (http://www.appveyor.com/docs/status-badges), but Travis CI doesn't. But Shields.io allows you to override the default left-hand-side text (which makes more sense) and supports both Travis CI and AppVeyor. TODO: update Windows branch to master when available. 2015-06-18 22:23:55 +03:00			`.. 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
Clarify build badges [Ci skip] Three "build: passing" badges in a row looks a bit odd. AppVeyor allows you to customise the right-hand side text (http://www.appveyor.com/docs/status-badges), but Travis CI doesn't. But Shields.io allows you to override the default left-hand-side text (which makes more sense) and supports both Travis CI and AppVeyor. TODO: update Windows branch to master when available. 2015-06-18 22:23:55 +03:00			`.. image:: https://img.shields.io/travis/python-pillow/pillow-wheels/latest.svg?label=OS%20X%20build`
Reinstate OS X badge [CI skip] 2015-06-08 16:12:28 +03:00			`:target: https://travis-ci.org/python-pillow/pillow-wheels`
			`:alt: Travis CI build status (OS X)`

Update Windows badge [ci skip] 2015-06-22 01:42:04 +03:00			`.. image:: https://img.shields.io/appveyor/ci/Pythonpillow/pillow/master.svg?label=Windows%20build`
			`:target: https://ci.appveyor.com/project/Pythonpillow/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
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`
			`:target: https://pypi.python.org/pypi/Pillow/`
			`:alt: Latest PyPI version`
Add PyPI badges! http://codeinthehole.com/writing/pypi-readme-badges/ 2013-10-06 19:22:41 +04:00
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/dm/pillow.svg`
			`:target: https://pypi.python.org/pypi/Pillow/`
			`:alt: Number of PyPI downloads`
Add PyPI badges! http://codeinthehole.com/writing/pypi-readme-badges/ 2013-10-06 19:22:41 +04:00
Added service argument to coveralls image URL [ci skip] 2015-07-08 16:08:00 +03:00			`.. image:: https://coveralls.io/repos/python-pillow/Pillow/badge.svg?branch=master&service=github`
Shields.io badges instead of broken pypip.in. PNG->SVG for consistency [CI skip] 2015-06-08 15:02:28 +03:00			`:target: https://coveralls.io/r/python-pillow/Pillow?branch=master`
Add Landscape config and badge 2014-10-01 15:46:32 +04:00			`:alt: Code coverage`

Revert "Remove badge [ci skip]" This reverts commit 0387cfe9127e5fffd3a1973c14347a1c78b8dae0. 2015-09-30 01:11:15 +03:00			`.. image:: https://landscape.io/github/python-pillow/Pillow/master/landscape.svg`
Add Landscape config and badge 2014-10-01 15:46:32 +04:00			`:target: https://landscape.io/github/python-pillow/Pillow/master`
			`:alt: Code health`
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
			`More Information`
			`----------------`

s/http/https/ [ci skip] 2015-09-29 14:11:55 +03:00			- `Documentation <https://pillow.readthedocs.org/>`_
Include link to pre-fork changelog [ci skip] 2015-04-01 17:33:11 +03:00
s/http/https/ [ci skip] 2015-09-29 14:11:55 +03:00			- `Installation <https://pillow.readthedocs.org/installation.html>`_
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 <https://pillow.readthedocs.org/handbook/index.html>`_
Include link to pre-fork changelog [ci skip] 2015-04-01 17:33:11 +03: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			- `Contribute <https://github.com/python-pillow/Pillow/blob/master/CONTRIBUTING.md>`_
Add header to orig readme [ci skip] So we can link to it from README 2015-04-01 17:29:01 +03:00
			- `Issues <https://github.com/python-pillow/Pillow/issues>`_
README fixes - Add Makefile target ``make readme`` to run ``viewdoc`` - Reorg "More Info" sections - Docs to the top - Less doc links (folks can find more than installation & guides from documentation link) - Add link to PRs - Reorg link to pre-fork changes 2015-09-29 13:35:07 +03:00			- `Pull requests <https://github.com/python-pillow/Pillow/pulls>`_
Add header to orig readme [ci skip] So we can link to it from README 2015-04-01 17:29:01 +03:00
README fixes - Add Makefile target ``make readme`` to run ``viewdoc`` - Reorg "More Info" sections - Docs to the top - Less doc links (folks can find more than installation & guides from documentation link) - Add link to PRs - Reorg link to pre-fork changes 2015-09-29 13:35:07 +03:00			- `Changelog <https://github.com/python-pillow/Pillow/blob/master/CHANGES.rst>`_
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
README fixes - Add Makefile target ``make readme`` to run ``viewdoc`` - Reorg "More Info" sections - Docs to the top - Less doc links (folks can find more than installation & guides from documentation link) - Add link to PRs - Reorg link to pre-fork changes 2015-09-29 13:35:07 +03:00			- `Pre-fork <https://github.com/python-pillow/Pillow/blob/master/CHANGES.rst#pre-fork>`_