Skip to content
Open source UI framework written in Python, running on Windows, Linux, OS X, Android and iOS
Python C HTML Objective-C Emacs Lisp Makefile
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
doc
examples
kivy
.gitignore
AUTHORS
COPYING
MANIFEST.in
Makefile
README
setup.cfg
setup.py

README

Kivy - A Gestural Toolkit living in GPU
=======================================

Website: http://kivy.org/

Kivy is the toolkit derivated from PyMT.


About 1.0 alpha
---------------

This is alpha, so keep in mind that it might not work as intended at all times.
You can post bug reports and feature requests on our Google Project page :

  http://code.google.com/p/kivy/issues/list

If you need more help, you can discuss on mailing list :

  * Google Group : http://groups.google.com/group/kivy-dev
  * Email        : kivy-dev@googlegroups.com

We also have an IRC channel :

  * Server  : irc.freenode.net
  * Channel : #kivy


Introduction
------------

Kivy is a python module for developing multi-touch enabled media rich
applications. Currently the aim is to allow for quick and easy interaction
design and rapid prototype development.

Kivy is written in python, based on OpenGL and supports different input methods
like Mouse, Dual Mouse, TUIO, WiiMote, WM_TOUCH, HIDtouch etc.

Kivy is actively being developed by a community and free to use. It operates on
all major platforms (Linux, OSX, Windows).


Installation
------------

Depending on your operating system you can follow one of the following guides
to install Kivy and the dependencies:

 * http://kivy.org/wiki/DevGuide/InstallKivyUbuntu
 * http://kivy.org/wiki/DevGuide/InstallKivyMacOSX
 * http://kivy.org/wiki/DevGuide/InstallKivyWindows

If you chose to install all the dependencies (see below) yourself, you can invoke
the setup script as follows to install kivy systemwide for python:

  python setup.py install


Dependencies
------------

Since we abstract from the libraries that we use, some dependencies are
optional and may be used instead of others. A list of dependencies and what
we use them for is http://kivy.org/wiki/Devel/FeaturesByLibraries

Here is what works best:

  * python (>= 2.6, < 3.0) - http://python.org
  * PyOpenGL >= 3.0.1
  * Pygame
  * PIL
  * GST + PyGST
  * Cython
  * nosetests >= 0.11 (for unittest)
  * coverage >= 0.34 (for coverage)


Dcoumentation, Examples & Tutorials
-----------------------------------

There is an API reference included in doc. Check the doc/README about how
to build the documentation. It's also available online at :

	http://kivy.org/docs/

There is some simple example apps in the examples folder that should get
you started for now. Additionally you may want to take a look at our wiki
at :

	http://kivy.org/wiki/


Other Python/MT resources
-------------------------

pymt.eu
^^^^^^^

Experimental toolkit in python for multitouch interaction.
Now deprecated in favour of Kivy.

movid.org
^^^^^^^^^

Another image tracker we are working on.

nuigroup.com
^^^^^^^^^^^^

THE resource and research community for open source multi touch and other
natural user interfaces.


Licence
-------

- Kivy is licenced under LGPL 3, check the COPYING file.
- DroidSans.ttf and DroidSansMono.ttf are licenced under Apache 2.0 Licence.
  The license can be found at http://www.apache.org/licenses/LICENSE-2.0
- Current ui design have been taken from SVG of Moblintouch theme, licenced under LGPL 2.1.
Something went wrong with that request. Please try again.