1.. _install:
2
3Download and Installation
4==========================
5
6
7Installation
8--------------
9
10**Method with pip:** if you have ``pip`` installed, just type this in a terminal (it will install ez_setup if you don't already have it) ::
11
12    (sudo) pip install moviepy
13
14If you have neither ``setuptools`` nor ``ez_setup`` installed the command above will fail, is this case type this before installing: ::
15
16    (sudo) pip install ez_setup
17
18**Method by hand:** download the sources, either on PyPI_ or (if you want the development version) on Github_, unzip everything in one folder, open a terminal and type ::
19
20    (sudo) python setup.py install
21
22MoviePy depends on the Python modules Numpy_, imageio_, Decorator_, and tqdm_, which will be automatically installed during MoviePy's installation. It should work  on Windows/Mac/Linux, with Python 2.7+ and 3 ; if you have trouble installing MoviePy or one of its dependencies, please provide feedback !
23
24MoviePy depends on the software FFMPEG for video reading and writing. You don't need to worry about that, as FFMPEG should be automatically downloaded/installed by ImageIO during your first use of MoviePy (it takes a few seconds). If you want to use a specific version of FFMPEG, you can set the FFMPEG_BINARY environment variable See ``moviepy/config_defaults.py`` for details.
25
26
27Other optional but useful dependencies
28~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29
30ImageMagick_ is not strictly required, only if you want to write texts. It can also be used as a backend for GIFs but you can do GIFs with MoviePy without ImageMagick.
31
32Once you have installed it, ImageMagick will be automatically detected by MoviePy, **except on Windows !**. Windows user, before installing MoviePy by hand, go into the ``moviepy/config_defaults.py`` file and provide the path to the ImageMagick binary called `magick`. It should look like this ::
33
34    IMAGEMAGICK_BINARY = "C:\\Program Files\\ImageMagick_VERSION\\magick.exe"
35
36You can also set the IMAGEMAGICK_BINARY environment variable See ``moviepy/config_defaults.py`` for details.
37
38If you are using an older version of ImageMagick, keep in mind the name of the executable is not ``magick.exe`` but ``convert.exe``. In that case, the IMAGEMAGICK_BINARY property should be ``C:\\Program Files\\ImageMagick_VERSION\\convert.exe``
39
40PyGame_ is needed for video and sound previews (useless if you intend to work with MoviePy on a server but really essential for advanced video editing *by hand*).
41
42For advanced image processing you will need one or several of these packages. For instance using the method ``clip.resize`` requires that at least one of Scipy, PIL, Pillow or OpenCV are installed.
43
44- The Python Imaging Library (PIL) or, better, its branch Pillow_ .
45- Scipy_ (for tracking, segmenting, etc.), and can be used for resizing video clips if PIL and OpenCV aren't installed on your computer.
46- `Scikit Image`_ may be needed for some advanced image manipulation.
47- `OpenCV 2.4.6`_ or more recent (provides the package ``cv2``) or more recent may be needed for some advanced image manipulation.
48
49If you are on linux, these packages will likely be in your repos.
50
51.. _`Numpy`: https://www.scipy.org/install.html
52.. _Decorator: https://pypi.python.org/pypi/decorator
53.. _tqdm: https://pypi.python.org/pypi/tqdm
54
55.. _ffmpeg: https://www.ffmpeg.org/download.html
56
57
58.. _imageMagick: https://www.imagemagick.org/script/index.php
59.. _Pygame: https://www.pygame.org/download.shtml
60.. _imageio: https://imageio.github.io/
61
62.. _Pillow: https://pillow.readthedocs.org/en/latest/
63.. _Scipy: https://www.scipy.org/
64.. _`Scikit Image`: http://scikit-image.org/download.html
65
66.. _Github: https://github.com/Zulko/moviepy
67.. _PyPI: https://pypi.python.org/pypi/moviepy
68.. _`OpenCV 2.4.6`: https://sourceforge.net/projects/opencvlibrary/files/
69
70
71