Virtualenvwrapper 5.0.1.dev2¶. Virtualenvwrapper is a set of extensions to Ian Bicking’s virtualenv tool. The extensions include wrappers for creating and deleting virtual environments and otherwise managing your development workflow, making it easier to work on more than one project at a time without introducing conflicts in their dependencies. Install Compose. Follow the instructions below to install Compose on Mac, Windows, Windows Server 2016, or Linux systems, or find out about alternatives like using the pip Python package manager or installing Compose as a container. Install a different version. If you don't already have pip installed, you can install it by using the script that the Python Packaging Authority provides. Run pip -version to see if your version of Linux already includes Python and pip.

Table Of Contents

• Installing Kivy
  • Using pip
    • Install Kivy
  • Python glossary

Installation for Kivy version 2.0.0. Read the changelog here.For other Kivy versions, select the documentation from the dropdown on the top left.

Kivy 2.0.0 officially supports Python versions 3.6 - 3.9.

Using pip¶

The easiest way to install Kivy is with pip, which installs Kivy using either apre-compiled wheel, if available, otherwise from source (see below).

Kivy provides pre-compiled wheels for the supported Pythonversions on Windows, OS X, Linux, and RPi. Alternatively, installingfrom source is required for newer Python versions not listedabove or if the wheels do not work or fail to run properly.

Setup terminal and pip¶

Before Kivy can be installed, Python and pip needs to be pre-installed.Then, start a new terminal that hasPython available. In the terminal, update pip and other installationdependencies so you have the latest version as follows (for linux users you may have tosubstitute python3 instead of python and also add a --user flag in thesubsequent commands outside the virtual environment):

Create virtual environment¶

Create a new virtual environmentfor your Kivy project. A virtual environment will prevent possible installation conflictswith other Python versions and packages. It’s optional but strongly recommended:

1. Create the virtual environment named kivy_venv in your current directory:

2. Activate the virtual environment. You will have to do this step from the current directoryevery time you start a new terminal. This sets up the environment so the new kivy_venvPython is used.

   For Windows default CMD, in the command line do:

   If you are in a bash terminal on Windows, instead do:

   If you are in linux, instead do:

Your terminal should now preface the path with something like (kivy_venv), indicating thatthe kivy_venv environment is active. If it doesn’t say that, the virtual environmentis not active and the following won’t work.

Install Kivy¶

Finally, install Kivy using one of the following options:

Pre-compiled wheels¶

The simplest is to install the current stable version of kivy and optionally kivy_examplesfrom the kivy-team provided PyPi wheels. Simply do:

This also installs the minimum dependencies of Kivy. To additionally install Kivy withaudio/video support, install either kivy[base,media] or kivy[full].See Kivy’s dependencies for the list of selectors.

For the Raspberry Pi, you must additionally install the dependencies listed insource dependencies before installing Kivy above.

From source¶

If a wheel is not available or is not working, Kivy can be installed from sourcewith some additional steps. Installing from source means that Kivy will be installedfrom source code and compiled directly on your system.

First install the additional system dependencies listed for each platform:Windows, OS X,Linux, RPi.

With the dependencies installed, you can now install Kivy into the virtual environment.

To install the stable version of Kivy, from the terminal do:

To install the latest cutting-edge Kivy from master, instead do:

If you want to install Kivy from a different branch, from your forked repository, orfrom a specific commit (e.g. to test a fix from a user’s PR) replace the correspondingcomponents of the url.

Pip Install Os Library

For example to install from the stable branch, the url becomeshttps://github.com/kivy/kivy/archive/stable.zip. Or to try a specific commit hash, use e.g.https://github.com/kivy/kivy/archive/3d3e45dda146fef3f4758aea548da199e10eb382.zip

Pre-release, pre-compiled wheels¶

To install a pre-compiled wheel of the last pre-release version of Kivy, instead of thecurrent stable version, add the --pre flag to pip:

This will only install a development version of Kivy if one was released toPyPi. Instead, one can also install thelatest cutting-edgeNightly wheels from the Kivy server with:

It is done in two steps, because otherwise pip may ignore the wheels on the server and installan older pre-release version from PyPi.

For the Raspberry Pi, remember to additionally install the dependencies listed insource dependencies before installing Kivy above.

Development install¶

If you want to edit Kivy before installing it, or if you want to try fixing some Kivy issueand submit a pull request with the fix, you will need to first download the Kivy source code.The following steps assumes git is pre-installed and available in the terminal.

The typical process is to clone Kivy locally with:

This creates a kivy named folder in your current path. Next, install the additionalsystem dependencies listed for each OS: Windows,OS X, Linux,RPi.

Then change to the kivy directory and install Kivy as aneditable install:

Now, you can use git to change branches, edit the code and submit a PR.Remember to compile Kivy each time you change cython files as follows:

Or if using bash or on Linux, simply do:

to recompile.

To run the test suite, simply run:

or in bash or Linux:

Checking the demo¶

Kivy should now be installed. You should be able to importkivy in Python or,if you installed the Kivy examples, run the demo (on Windows):

or in bash or Linux:

The exact path to the Kivy examples directory is also stored in kivy.kivy_examples_dir.

The 3d monkey demo under kivy-examples/3Drendering/main.py is also fun to see.

Installation using Conda¶

If you use Anaconda, you caninstall Kivy with its package manager Conda using:

Do not use pip to install kivy if you’re using Anaconda, unless you’re installing from source.

Installing Kivy’s dependencies¶

Kivy supports one or more backends for its core providers. E.g. it supports glew, angle,and sdl2 for the graphics backend on Windows. For each category (window, graphics, video,audio, etc.), at least one backend must be installed to be able to use the category.

To facilitate easy installation, we provide extras_requiregroupsthat will install selected backends to ensure a working Kivy installation. So one can installKivy more simply with e.g.``pip install kivy[base,media,tuio]``. The full list of selectors andthe packages they install is listed insetup.py. The exact packages in each selectormay change in the future, but the overall goal of each selector will remain as described below.

We offer the following selectors:

not including video/audio.

be able to play media.

most optional dependencies.

(i.e. it doesn’t include the base/media/full dependencies). E.g. any headers required forcompilation, and all dependencies required to run the tests and creating the docs.

tuio: The dependencies required to make TUIO work (primarily oscpy).

The following selectors install backends packaged as wheels by kivy under the Kivy_deps namespace.They are typically released and versioned to match specific Kivy versions, so we provide selectorsto facilitate installation (i.e. instead of having to do pipinstallkivykivy_deps.sdl2x.y.z,you can now do pipinstallkivy[sdl2] to automatically install the correct sdl2 for the Kivyversion).

(currently only on Windows)

(currently only on Windows)

on OSX and Linux it is already included in the main Kivy wheel).

glew: A alternate OpenGL backend, if it’s available (currently only on Windows)

Following are the kivy_deps dependency wheels:

• gstreamer (optional)

  kivy_deps.gstreamer is an optional dependency which is only needed for audio/video support.We only provide it on Windows, for other platforms it must be installed independently.Alternatively, use ffpyplayer instead.

• glew and/orangle

  kivy_deps.glew and kivy_deps.angle are for OpenGL.You can install both, that is no problem. It is only available on Windows. On otherplatforms it is not required externally.

  One can select which of these to use for OpenGL using theKIVY_GL_BACKEND environment variable: By setting it to glew(the default), angle_sdl2, or sdl2. Here, angle_sdl2 is a substitute forglew but requires kivy_deps.sdl2 be installed as well.

• kivy_deps.sdl2 is for window/images/audio and optionally OpenGL. It is only available on Windowsand is included in the main Kivy wheel for other platforms.

Python glossary¶

Here we explain how to install Python packages, how to use the command line and what wheels are.

Installing Python¶

Kivy is written inPythonand as such, to use Kivy, you need an existinginstallation of Python.Multiple versions of Python can be installed side by side, but Kivy needs tobe installed as package under each Python version that you want to use Kivy in.

To install Python, see the instructions for each platform:Windows, OS X,Linux, RPi.

Once Python is installed, open the console and make surePython is available by typing python--version.

How to use the command line¶

To execute any of the pip or wheel commands given here, you need a command line (here also called console, terminal, shell or bash, where the last two refer to Linux style command lines) and Python must be on the PATH.

The default command line on Windows is thecommand prompt, short cmd. Thequickest way to open it is to press Win+R on your keyboard.In the window that opens, type cmd and then press enter.

Alternative Linux style command lines on Windows that we recommend areGit for Windows or Mysys.

Note, the default Windows command line can still be used, even if a bash terminal is installed.

To temporarily add your Python installation to the PATH, simply open your command line and then use the cd command to change the current directory to where python is installed, e.g. cdC:Python37.

If you have installed Python using the default options, then the path to Python will already be permanently on your PATH variable. There is an option in the installer which lets you do that, and it is enabled by default.

If however Python is not on your PATH, follow the these instructions to add it:

• Instructions for the windows command line

• Instructions for bash command lines

What is pip and what are wheels¶

In Python, packages such as Kivy can be installed with the python packagemanager, named pip (“python install package”).

When installing from source, some packages, such as Kivy, require additional steps, like compilation.

Contrary, wheels (files with a .whl extension) are pre-builtdistributions of a package that has already been compiled.These wheels do not require additional steps when installing them.

When a wheel is available on pypi.org (“Python Package Index”) it can be installed with pip. For example when you execute python-mpipinstallkivy in a command line, this will automatically find the appropriate wheel on PyPI.

When downloading and installing a wheel directly, use the commandpython-mpipinstall<wheel_file_name>, for example:

What are nightly wheels¶

Every day we create a snapshot wheel of the current development version of Kivy (‘nightly wheel’).You can find the development version in the master branch of theKivy Github repository.

As opposed to the last stable release (which we discussed in the previous section), nightlywheels contain all the latest changes to Kivy, including experimental fixes.For installation instructions, see Pre-release, pre-compiled wheels.

Warning

Pip Install Osx App

Using the latest development version can be risky and you might encounterissues during development. If you encounter any bugs, please report them.