Quick search

Installation on Linux

Using software packages

For installing distribution relative packages .deb/.rpm/...

Ubuntu / Kubuntu / Xubuntu / Lubuntu (Saucy and above)

  1. In case you want to use Python3, add this Pygame PPA before

    $ sudo add-apt-repository ppa:thopiekar/pygame

    ** These Pygame packages are neither provided nor supported by the Kivy project. ** Please contact the creator of the package(s) or maintainer of the sourcecode for further help.

  2. Add one of the PPAs as you prefer

    stable builds:$ sudo add-apt-repository ppa:kivy-team/kivy
    nightly builds:$ sudo add-apt-repository ppa:kivy-team/kivy-daily
  3. Update your packagelist using your package manager

  4. Install Kivy

    Python2 - python-kivy:
     $ sudo apt-get install python-kivy
    Python3 - python3-kivy:
     $ sudo apt-get install python3-kivy
    optionally the examples - kivy-examples:
     $ sudo apt-get install kivy-examples

Debian (Jessie or newer)

  1. Add one of the PPAs to your sources.list in apt manually or via Synaptic

  2. Add the GPG key to your apt keyring by executing

    as user:

    sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys A863D2D6

    as root:

    apt-key adv --keyserver keyserver.ubuntu.com --recv-keys A863D2D6

  3. Refresh your package list and install python-kivy and/or python3-kivy and optionally the examples found in kivy-examples

Linux Mint

  1. Find out on which Ubuntu release your installation is based on, using this overview.
  2. Continue as described for Ubuntu above, depending on which version your installation is based on.

Bodhi Linux

  1. Find out which version of the distribution you are running and use the table below to find out on which Ubuntu LTS it is based.

    Bodhi 1:Ubuntu 10.04 LTS aka Lucid (No packages, just manual install)
    Bodhi 2:Ubuntu 12.04 LTS aka Precise
    Bodhi 3:Ubuntu 14.04 LTS aka Trusty
  1. Continue as described for Ubuntu above, depending on which version your installation is based on.

OpenSuSE

  1. Installing via One-Click-Install

  1. If you would like access to the examples, use your preferred package-manager to install python-Kivy-examples

Fedora

  1. Adding the repository via the terminal:

    Fedora 18

    $ sudo yum-config-manager --add-repo=http://download.opensuse.org/repositories/home:/thopiekar:/kivy/Fedora_18/home:thopiekar:kivy.repo

    Fedora 17

    $ sudo yum-config-manager --add-repo=http://download.opensuse.org/repositories/home:/thopiekar:/kivy/Fedora_17/home:thopiekar:kivy.repo

    Fedora 16

    $ sudo yum-config-manager --add-repo=http://download.opensuse.org/repositories/home:/thopiekar:/kivy/Fedora_16/home:thopiekar:kivy.repo
  2. Use your preferred package-manager to refresh your packagelists

  3. Install python-Kivy and optionally the examples, as found in python-Kivy-examples

Gentoo

  1. There is a kivy ebuild (kivy stable version)

    emerge Kivy

  2. available USE-flags are:

    cairo: Standard flag, let kivy use cairo graphical libraries. camera: Install libraries needed to support camera. doc: Standard flag, will make you build the documentation localy. examples: Standard flag, will give you kivy examples programs. garden: Install garden tool to manage user maintained widgets. gstreamer: Standard flag, kivy will be able to use audio/video streaming libraries. spell: Standard flag, provide enchant to use spelling in kivy apps.

Using software bundles ( also known as tarballs )

Providing dependencies

General

The following software is needed, even if your distribution is not listed above:

We prefer to use a package-manager to provide these dependencies.

Ubuntu

$ sudo apt-get install pkg-config python-setuptools python-pygame python-opengl \
  python-gst0.10 python-enchant gstreamer0.10-plugins-good python-dev \
  build-essential libgl1-mesa-dev libgles2-mesa-dev cython

Upgrade Cython ( <= Oneiric [11.10] )

Using Cython’s daily PPA:
 
$ sudo add-apt-repository ppa:cython-dev/master-ppa
$ sudo apt-get update
$ sudo apt-get install cython
Using PIP:
$ sudo apt-get install python-pip
$ sudo pip install --upgrade cython

Fedora

$ sudo yum install python-distutils-extra python-enchant freeglut PyOpenGL \
SDL_ttf-devel SDL_mixer-devel pygame pygame-devel khrplatform-devel \
mesa-libGLES mesa-libGLES-devel gstreamer-plugins-good gstreamer \
gstreamer-python mtdev-devel python-pip
$ sudo pip install --upgrade cython
$ sudo pip install pygments

OpenSuse

$ sudo zypper install python-distutils-extra python-pygame python-opengl \
python-gstreamer-0_10 python-enchant gstreamer-0_10-plugins-good \
python-devel Mesa-devel python-pip
$ zypper install -t pattern devel_C_C++
$ sudo pip install --upgrade cython
$ sudo pip install pygments

Mageia 1 onwards

$ su
# urpmi python-setuptools python-pygame python-opengl \
gstreamer0.10-python python-enchant gstreamer0.10-plugins-good \
python-cython lib64python-devel lib64mesagl1-devel lib64mesaegl1-devel \
lib64mesaglesv2_2-devel make gcc
# easy_install pip
# pip install --upgrade cython
# pip install pygments

Installation in a Virtual Environment with System Site Packages

This is a recommended compromise between installing Kivy and its dependencies system wide and installing as much as possible into a virtual environment.

Ubuntu 12.04 with Python 2.7

Install System-wide Dependencies

Note that these commands will remove any pre-existing versions of python-virtualenv and replace it with the current version. It will also remove cython, numpy, and pygame installed from your Linux distro’s repository and replace them with current versions from pip or the pygame Mercurial repository.

# Install necessary system packages
sudo apt-get install -y build-essential mercurial git python2.7 \
python-setuptools python-dev ffmpeg libsdl-image1.2-dev \
libsdl-mixer1.2-dev libsdl-ttf2.0-dev libsmpeg-dev libsdl1.2-dev \
libportmidi-dev libswscale-dev libavformat-dev libavcodec-dev zlib1g-dev

# Bootstrap a current Python environment
    sudo apt-get remove --purge -y python-virtualenv python-pip
    sudo easy_install-2.7 -U pip
    sudo pip2.7 install -U virtualenv

    # Install current version of Cython
    sudo apt-get remove --purge -y cython
    sudo pip2.7 install -U cython

    # Install other PyGame dependencies
    sudo apt-get remove --purge -y python-numpy
    sudo pip2.7 install -U numpy

    # Install PyGame
    sudo apt-get remove --purge python-pygame
    hg clone https://bitbucket.org/pygame/pygame
    cd pygame
    python2.7 setup.py build
    sudo python2.7 setup.py install
    cd ..
    sudo rm -rf pygame

Create a Kivy Virtualenv

# Create a vitualenv
rm -rf venv
virtualenv -p python2.7 --system-site-packages venv

# Install stable version of Kivy into the virtualenv
venv/bin/pip install kivy
# For the development version of Kivy, use the following command instead
# venv/bin/pip install git+https://github.com/kivy/kivy.git@master

# Install development version of buildozer into the virtualenv
venv/bin/pip install git+https://github.com/kivy/buildozer.git@master

# Install development version of plyer into the virtualenv
venv/bin/pip install git+https://github.com/kivy/plyer.git@master

# Install a couple of dependencies for KivyCatalog
venv/bin/pip install -U pygments docutils

Ubuntu 12.04 with Python 3.3

Install System-wide Dependencies

Note that these commands will remove any pre-existing versions of python-virtualenv and replace it with the current version. It will also remove cython, numpy, and pygame installed from your Linux distro’s repository and replace them with current versions from pip or the pygame Mercurial repository.

# Bootstrap Python3.3
    sudo apt-get install python-software-properties
    sudo add-apt-repository ppa:fkrull/deadsnakes
    sudo apt-get update

    # Install necessary system packages
    sudo apt-get install -y build-essential mercurial git python3.3 \
    python3.3-dev ffmpeg libsdl-image1.2-dev libsdl-mixer1.2-dev \
    libsdl-ttf2.0-dev libsmpeg-dev libsdl1.2-dev libportmidi-dev \
    libswscale-dev libavformat-dev libavcodec-dev zlib1g-dev

    # Bootstrap current setuptools
    wget https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py -O - | sudo python3.3

    # Bootstrap a current Python environment
    sudo apt-get remove --purge -y python-virtualenv python-pip
    sudo easy_install-3.3 -U pip
    sudo pip3.3 install -U virtualenv

    # Install current version of Cython
    sudo apt-get remove --purge -y cython
    sudo pip3.3 install -U cython

    # Install other PyGame dependencies
    sudo apt-get remove --purge -y python-numpy
    sudo pip3.3 install -U numpy

    # Install PyGame
    hg clone https://bitbucket.org/pygame/pygame
    cd pygame
    python3.3 setup.py build
    sudo python3.3 setup.py install
    cd ..
    sudo rm -rf pygame

Create a Kivy Virtualenv

# Create a vitualenv
rm -rf venv
virtualenv -p python3.3 --system-site-packages venv

# Install stable version of Kivy into the virtualenv
venv/bin/pip install kivy
# For the development version of Kivy, use the following command instead
# venv/bin/pip install git+https://github.com/kivy/kivy.git@master

# Install development version of buildozer into the virtualenv
#venv/bin/pip install git+https://github.com/kivy/buildozer.git@master

# Install development version of plyer into the virtualenv
venv/bin/pip install git+https://github.com/kivy/plyer.git@master

# Install a couple of dependencies for KivyCatalog
venv/bin/pip install -U pygments docutils

Start from the Command Line

We ship some examples that are ready-to-run. However, theses examples are packaged inside the package. This means you must first know where easy_install has installed your current kivy package, and then go to the examples directory:

$ python -c "import pkg_resources; print(pkg_resources.resource_filename('kivy', '../share/kivy-examples'))"

And you should have a path similar to:

/usr/local/lib/python2.6/dist-packages/Kivy-1.0.4_beta-py2.6-linux-x86_64.egg/share/kivy-examples/

Then you can go to the example directory, and run it:

# launch touchtracer
$ cd <path to kivy-examples>
$ cd demo/touchtracer
$ python main.py

# launch pictures
$ cd <path to kivy-examples>
$ cd demo/pictures
$ python main.py

If you are familiar with Unix and symbolic links, you can create a link directly in your home directory for easier access. For example:

  1. Get the example path from the command line above

  2. Paste into your console:

    $ ln -s <path to kivy-examples> ~/
  3. Then, you can access to kivy-examples directly in your home directory:

    $ cd ~/kivy-examples

If you wish to start your Kivy programs as scripts (by typing ./main.py) or by double-clicking them, you will want to define the correct version of Python by linking to it. Something like:

$ sudo ln -s /usr/bin/python2.7 /usr/bin/kivy

Or, if you are running Kivy inside a virtualenv, link to the Python interpreter for it, like:

$ sudo ln -s /home/your_username/Envs/kivy/bin/python2.7 /usr/bin/kivy

Then, inside each main.py, add a new first line:

#!/usr/bin/kivy

NOTE: Beware of Python files stored with Windows-style line endings (CR-LF). Linux will not ignore the <CR> and will try to use it as part of the file name. This makes confusing error messages. Convert to Unix line endings.