summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: ea2bd8f347e313e450372e0cc8e98bc631f35ebd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
Wand
====

.. image:: https://badge.fury.io/py/Wand.svg?
   :alt: Latest PyPI version
   :target: https://pypi.python.org/pypi/Wand

.. image:: https://readthedocs.org/projects/wand/badge/
   :alt: Documentation Status
   :target: https://docs.wand-py.org/en/latest/

.. image:: https://app.travis-ci.com/emcconville/wand.svg?branch=master
   :alt: Build Status
   :target: https://app.travis-ci.com/emcconville/wand

.. image:: https://github.com/emcconville/wand/workflows/Wand%20CI/badge.svg
   :alt: Build Status
   :target: https://github.com/emcconville/wand/actions?query=workflow%3A%22Wand+CI%22

.. image:: https://img.shields.io/coveralls/emcconville/wand.svg?style=flat
   :alt: Coverage Status
   :target: https://coveralls.io/r/emcconville/wand

Wand is a :mod:`ctypes`-based simple ImageMagick_ binding for Python. ::

    from wand.image import Image
    from wand.display import display

    with Image(filename='mona-lisa.png') as img:
        print(img.size)
        for r in 1, 2, 3:
            with img.clone() as i:
                i.resize(int(i.width * r * 0.25), int(i.height * r * 0.25))
                i.rotate(90 * r)
                i.save(filename='mona-lisa-{0}.png'.format(r))
                display(i)

You can install it from PyPI_ (and it requires MagickWand library):

.. sourcecode:: bash

   $ apt-get install libmagickwand-dev
   $ pip install Wand

.. _ImageMagick: http://www.imagemagick.org/
.. _PyPI: https://pypi.python.org/pypi/Wand


Why just another binding?
-------------------------

There are already many MagickWand API bindings for Python, however they
are lacking something we need:

- Pythonic and modern interfaces
- Good documentation
- Binding through :mod:`ctypes` (not C API) --- we are ready to go PyPy!
- Installation using :program:`pip`


Requirements
------------

- Python 2.7 or higher

  - CPython 2.7 or higher
  - CPython 3.3 or higher
  - PyPy 1.5 or higher

- MagickWand library

  - ``libmagickwand-dev`` for APT on Debian/Ubuntu
  - ``imagemagick`` for MacPorts/Homebrew on Mac
  - ``ImageMagick-devel`` for Yum on CentOS


User's guide
------------

.. toctree::
   :maxdepth: 2

   whatsnew/0.6
   guide/install
   guide/security
   guide/read
   guide/write
   guide/resizecrop
   guide/effect
   guide/fx
   guide/transform
   guide/colorspace
   guide/colorenhancement
   guide/distortion
   guide/draw
   guide/exif
   guide/layers
   guide/montage
   guide/morphology
   guide/sequence
   guide/resource
   guide/quantize
   guide/threshold
   guide/cli
   test
   roadmap
   changes
   talks


References
----------

.. toctree::
   :maxdepth: 2

   wand


Troubleshooting
---------------

Stack Overflow
''''''''''''''

There's a Stack Overflow tag for Wand:

http://stackoverflow.com/questions/tagged/wand

Freely ask questions about Wand including troubleshooting.

Thanks to everyone in the `Stack Overflow community`__ for contributions.

__ https://stackoverflow.com/tags/wand/topusers


Documentation
'''''''''''''

The documentation_ for Wand is hosted by `ReadTheDocs.org`_. The nightly
development docs can be found under the latest_ version, and the most recent
release under stable_.  Previous & maintenance releases are also available.

.. _documentation: https://docs.wand-py.org
.. _ReadTheDocs.org: https://readthedocs.org
.. _latest: https://docs.wand-py.org/en/latest/
.. _stable: https://docs.wand-py.org/en/stable/


Open source
-----------

Wand is an open source software initially written by `Hong Minhee`_ (for
StyleShare_), and is currently maintained by E. McConville.  See also the
complete list of contributors_ as well. The source code is distributed under
`MIT license`_ and you can find it at `GitHub repository`_. Check out now:

.. sourcecode:: bash

   $ git clone git://github.com/emcconville/wand.git

If you find a bug, please notify to `our issue tracker`_. Pull requests
are always welcome!

Check out :doc:`changes` also.

.. _Hong Minhee: http://hongminhee.org/
.. _StyleShare: https://stylesha.re/
.. _contributors: https://github.com/emcconville/wand/graphs/contributors
.. _MIT license: http://minhee.mit-license.org/
.. _GitHub repository: https://github.com/emcconville/wand
.. _our issue tracker: https://github.com/emcconville/wand/issues


Indices and tables
------------------

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