Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
Open source UI framework written in Python, running on Windows, Linux, macOS, Android and iOS
License
kivy/kivy
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
* fix linux venv & build_kivy_deps.sh creation in docs as per issue 8305 change from: python -m virtualenv kivy_venv to: python -m venv kivy_venv change from: curl -O https://raw.githubusercontent.com/kivy/kivy/master/tools/build_linux_dependencies.sh -o build_kivy_deps.sh to: curl https://raw.githubusercontent.com/kivy/kivy/master/tools/build_linux_dependencies.sh -o build_kivy_deps.sh * Update installation.rst change from: https://virtualenv.pypa.io/en/latest/ to: https://docs.python.org/3/library/venv.html
Git stats
Files
Failed to load latest commit information.
README.md
Innovative user interfaces made easy.
Kivy is an open source, cross-platform Python framework for the development of applications that make use of innovative, multi-touch user interfaces. The aim is to allow for quick and easy interaction design and rapid prototyping whilst making your code reusable and deployable.
Kivy is written in Python and Cython, based on OpenGL ES 2, supports various input devices and has an extensive widget library. With the same codebase, you can target Windows, macOS, Linux, Android and iOS. All Kivy widgets are built with multitouch support.
Kivy is MIT licensed, actively developed by a great community and is supported by many projects managed by the Kivy Organization.
Installation, Documentation and Examples
Extensive installation instructions as well as tutorials and general documentation, including an API reference, can be found at https://kivy.org/docs. A PDF version is also available.
Kivy ships with many examples which can be found in the examples folder.
If you need assistance, you can ask for help on our mailing list:
We also have a Discord channel:
We love pull requests and discussing novel ideas. Check out our contribution guide and feel free to improve Kivy.
The following mailing list and Discord channel are used exclusively for discussions about developing the Kivy framework and its sister projects:
- Buildozer: generic Python packager for Android and iOS.
- Plyer: platform-independent Python wrapper for platform-dependent APIs.
- Pyjnius: dynamic access to the Java/Android API from Python.
- Pyobjus: dynamic access to the Objective-C/iOS API from Python.
- Python for Android: toolchain for building and packaging Python applications for Android.
- Kivy iOS: toolchain for building and packaging Kivy applications for iOS.
- Audiostream: library for direct access to the microphone and speaker.
- KivEnt: entity-based game engine for Kivy.
- Garden: widgets and libraries created and maintained by users.
- Oscpy: a fast and tested python2/3 implementation of OSC.
- Kivy is released under the terms of the MIT License. Please refer to the LICENSE file.
- The provided fonts Roboto and Roboto Mono are licensed and distributed under the terms of the Apache License, Version 2.0. The DejaVuSans (used for the virtual keyboard) license can be viewed here.
- The current UI design has been adapted from Moblintouch theme’s SVGs and is licensed under the terms of the LGPLv2.1.
This project exists thanks to all the people who contribute. [Contribute].
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
About
Open source UI framework written in Python, running on Windows, Linux, macOS, Android and iOS
Welcome to Kivy¶
Welcome to Kivy’s documentation. Kivy is an open source software library for the rapid development of applications equipped with novel user interfaces, such as multi-touch apps.
We recommend that you get started with Getting Started . Then head over to the Programming Guide . We also have Create an application if you are impatient.
You are probably wondering why you should be interested in using Kivy. There is a document outlining our Philosophy that we encourage you to read, and a detailed Architectural Overview .
If you want to contribute to Kivy, make sure to read Contributing . If your concern isn’t addressed in the documentation, feel free to Contact Us .
- Getting Started
- Introduction
- Installing Kivy
- A first App
- Properties
- Kv Design Language
- Events
- Non-widget stuff
- Layouts
- Drawing
- Packaging
- Diving in
- Philosophy
- Contributing
- FAQ
- Contact Us
- Kivy Basics
- Controlling the environment
- Configure Kivy
- Architectural Overview
- Events and Properties
- Input management
- Widgets
- Graphics
- Kv language
- Integrating with other Frameworks
- Packaging your application
- Package licensing
- Pong Game Tutorial
- A Simple Paint App
- Crash Course
- Kivy framework
- Low level Metrics
- Animation
- Application
- Atlas
- Kivy Base
- Cache manager
- Clock object
- Compatibility module for Python 2.7 and >= 3.4
- Configuration object
- Context
- Core Abstraction
- Audio
- Camera
- Clipboard
- OpenGL
- Image
- Spelling
- Text
- Text Markup
- Text layout
- Video
- Window
- Kivy module for binary dependencies.
- Effects
- Damped scroll effect
- Kinetic effect
- Opacity scroll effect
- Scroll effect
- Event dispatcher
- Event Manager
- Factory object
- Garden
- Geometry utilities
- Gesture recognition
- Graphics
- BoxShadow
- CGL: standard C interface for OpenGL
- Graphics compiler
- Context management
- Context instructions
- Framebuffer
- GL instructions
- Canvas
- OpenGL
- OpenGL utilities
- Scissor Instructions
- Shader
- Stencil instructions
- SVG
- Tesselator
- Texture
- Transformation
- Input management
- Motion Event Factory
- Motion Event
- Input Postprocessing
- Calibration
- Dejitter
- Double Tap
- Ignore list
- Retain Touch
- Triple Tap
- Motion Event Provider
- Providers
- Android Joystick Input Provider
- Native support for HID input from the linux kernel
- Leap Motion — finger only
- Native support of Wacom tablet from linuxwacom driver
- Native support of MultitouchSupport framework for MacBook (MaxOSX platform)
- Mouse provider implementation
- Native support for Multitouch devices on Linux, using libmtdev.
- Auto Create Input Provider Config Entry for Available MT Hardware (linux only).
- TUIO Input Provider
- Common definitions for a Windows provider
- Input recorder
- Motion Event Shape
- Interactive launcher
- Kivy Language
- Builder
- Parser
- External libraries
- DDS File library
- GstPlayer
- Python mtdev
- Asynchronous data loader
- Kivy Logging
- Metrics
- Modules
- Console
- Inspector
- JoyCursor
- Keybinding
- Monitor module
- Recorder module
- Screen
- Touchring
- Web Debugger
- Multistroke gesture recognizer
- Network support
- UrlRequest
- Parser utilities
- Properties
- Resources management
- Storage
- Dictionary store
- JSON store
- Redis Store
- Support
- Tools
- Packaging
- Pyinstaller hooks
- Widgets
- Accordion
- Action Bar
- Anchor Layout
- Behaviors
- Button Behavior
- Code Navigation Behavior
- Compound Selection Behavior
- Cover Behavior
- Drag Behavior
- Emacs Behavior
- Focus Behavior
- Kivy Namespaces
- ToggleButton Behavior
- Touch Ripple
- Box Layout
- Bubble
- Button
- Camera
- Carousel
- CheckBox
- Code Input
- Color Picker
- Drop-Down List
- EffectWidget
- FileChooser
- Float Layout
- Gesture Surface
- Grid Layout
- Image
- Label
- Layout
- ModalView
- PageLayout
- Popup
- Progress Bar
- RecycleBoxLayout
- RecycleGridLayout
- RecycleLayout
- RecycleView
- RecycleView Data Model
- RecycleView Layouts
- RecycleView Views
- Relative Layout
- reStructuredText renderer
- Sandbox
- Scatter
- Scatter Layout
- Screen Manager
- ScrollView
- Settings
- Slider
- Spinner
- Splitter
- Stack Layout
- Stencil View
- Switch
- TabbedPanel
- Text Input
- Toggle button
- Tree View
- Video
- Video player
- VKeyboard
- Widget class
- Utils
- Vector
- Weak Method
- Weak Proxy
Appendix¶
The appendix contains licensing information and an enumeration of all the different modules, classes, functions and variables available in Kivy.
License¶
Kivy is released and distributed under the terms of the MIT license starting version 1.7.2. Older versions are still under the LGPLv3.
You should have received a copy of the MIT license alongside your Kivy distribution. See the LICENSE file in the Kivy root folder. An online version of the license can be found at:
In a nutshell, the license allows you to use Kivy in your own projects regardless of whether they are open source, closed source, commercial or free. Even if the license doesn’t require it, we would really appreciate when you make changes to the Kivy sourcecode itself, share those changes with us!
For a list of authors, please see the file AUTHORS that accompanies the Kivy source code distribution (next to LICENSE).
Kivy – Copyright 2010-2023, The Kivy Authors.
Introduction¶
Creating Kivy apps is fun and rewarding. This guide should be the perfect starting point to get you on the right track for app development. You will require a basic knowledge of Python to follow this introduction.
If you need more background on the Python language, you might be interested in these tutorials:
With Kivy, you can create apps that run on:
- Desktop computers: macOS, Linux, * BSD Unix, Windows.
- iOS devices: iPad, iPhone.
- Android devices: tablets, phones.
- Any other touch-enabled professional/homebrew devices supporting TUIO (Tangible User Interface Objects).
Kivy empowers you with the freedom to write your code once and have it run as-is on different platforms.
Follow this guide to get the tools you need, understand the major concepts and learn best practices. As this is an introduction, pointers to more information will be provided at the end of each section.
As you proceed through the guide, you will, using Kivy:
- Learn: The basics of programming with the Kivy language.
- Explore: The Kivy framework.
- Create: A simple cross-platform app.
- Package: For your choice of platform.
Finally, you will learn how to Deploy on the device of your choice.
Each section of the guide introduces a new topic, trying to give you enough information to get started and links to related articles for more in-depth explanations. When you are done with this guide, you’ll be able to develop Kivy apps and you will know where to look for information for the more challenging stuff your innovative applications will require.
Enough introductions, let’s get down to business.
