Download and Installation¶
Installation¶
Method with pip: if you have pip
installed, just type this in a terminal
$ (sudo) pip install moviepy
If you have neither setuptools
nor ez_setup
installed the command above will fail. In this case type the following before installing:
$ (sudo) pip install setuptools
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
$ (sudo) python setup.py install
MoviePy depends on the Python modules NumPy, Imageio, Decorator, and Proglog, which will be automatically installed during MoviePy’s installation. It should work on Windows/macOS/Linux, with Python 3.6+. If you have trouble installing MoviePy or one of its dependencies, please provide feedback in a Github issue!
MoviePy 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.
Other optional but useful dependencies¶
You can install moviepy
with all dependencies via:
$ (sudo) pip install moviepy[optional]
ImageMagick is not strictly required, but needed if you want to use TextClips. It can also be used as a backend for GIFs, though you can also create GIFs with MoviePy without ImageMagick.
Once you have installed ImageMagick, MoviePy will try to autodetect the path to its executable. If it fails, you can still configure it by setting environment variables.
PyGame is needed for video and sound previews (useless you intend to work with MoviePy on a server but really essential for advanced video editing by hand).
For 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.
The Python Imaging Library (PIL) or, better, its branch Pillow .
Scipy is needed for tracking, segmenting, etc., and can be used for resizing video clips if PIL and OpenCV aren’t installed on your computer.
Scikit Image may be needed for some advanced image manipulation.
OpenCV (provides the package
cv2
) may be needed for some advanced image manipulation.
If you are on Linux, these packages will likely be in your repos.
For Ubuntu 16.04LTS users, after installing MoviePy on the terminal, ImageMagick may not be detected by MoviePy. This bug can be fixed. Modify the file /etc/ImageMagick-6/policy.xml
commenting out the statement:
<!-- <policy domain="path" rights="none" pattern="@*" /> -->
Custom paths to external tools¶
There are a couple of environment variables used by MoviePy that allow you to configure custom paths to the external tools.
To setup any of these variables, the easiest way is to do it in Python before importing objects from MoviePy. For example:
import os
os.environ["FFMPEG_BINARY"] = "/path/to/custom/ffmpeg"
Alternatively, after installing the optional dependencies, you can create
a .env
file in your working directory that will be automatically read.
For example
FFMPEG_BINARY=/path/to/custom/ffmpeg
There are 2 available environment variables:
FFMPEG_BINARY
Normally you can leave it to its default (‘ffmpeg-imageio’) in which case imageio will download the right ffmpeg binary (on first use) and then always use that binary.
The second option is
"auto-detect"
. In this case ffmpeg will be whatever binary is found on the computer: generallyffmpeg
(on Linux/macOS) orffmpeg.exe
(on Windows).Lastly, you can set it to use a binary at a specific location on your disk by specifying the exact path.
IMAGEMAGICK_BINARY
The default is
"auto-detect"
.You can set it to use a binary at a specific location on your disk. On Windows, this might look like:
os.environ["IMAGEMAGICK_BINARY"] = r"C:\Program Files\ImageMagick-6.8.8-Q16\magick.exe"
Note: If you are using a legacy version of ImageMagick, the executable could be
convert.exe
instead.
To test if FFmpeg and ImageMagick are found by MoviePy, in a Python console run:
>>> from moviepy.config import check
>>> check()