Table Of Contents

• Kivy framework

Kivy framework

Kivy is an open source library for developing multi-touch applications. It is cross-platform (Linux/OSX/Windows/Android/iOS) and released under the terms of the MIT License.

It comes with native support for many multi-touch input devices, a growing library of multi-touch aware widgets and hardware accelerated OpenGL drawing. Kivy is designed to let you focus on building custom and highly interactive applications as quickly and easily as possible.

With Kivy, you can take full advantage of the dynamic nature of Python. There are thousands of high-quality, free libraries that can be integrated in your application. At the same time, performance-critical parts are implemented using Cython.

See http://kivy.org for more information.

kivy.kivy_base_dir = '/home/runner/work/kivy/kivy/kivy'

Kivy directory

kivy.kivy_config_fn = ''

Kivy configuration filename

kivy.kivy_configure()

Call post-configuration of Kivy. This function must be called if you create the window yourself.

kivy.kivy_data_dir = '/home/runner/work/kivy/kivy/kivy/data'

Kivy data directory

kivy.kivy_examples_dir = '/home/runner/work/kivy/kivy/examples'

Kivy examples directory

kivy.kivy_home_dir = ''

Kivy user-home storage directory

kivy.kivy_icons_dir = '/home/runner/work/kivy/kivy/kivy/data/icons/'

Kivy icons config path (don’t remove the last ‘’)

kivy.kivy_options = {'audio': ('gstplayer', 'pygame', 'ffpyplayer', 'sdl2', 'avplayer'), 'camera': ('opencv', 'gi', 'avfoundation', 'android', 'picamera'), 'clipboard': ('android', 'winctypes', 'xsel', 'xclip', 'dbusklipper', 'nspaste', 'sdl2', 'pygame', 'dummy', 'gtk3'), 'image': ('tex', 'imageio', 'dds', 'sdl2', 'pygame', 'pil', 'ffpy', 'gif'), 'spelling': ('enchant', 'osxappkit'), 'text': ('pil', 'sdl2', 'pygame', 'sdlttf'), 'video': ('gstplayer', 'ffmpeg', 'ffpyplayer', 'null'), 'window': ('egl_rpi', 'sdl2', 'pygame', 'sdl', 'x11')}

Global settings options for kivy

kivy.kivy_register_post_configuration(callback)

Register a function to be called when kivy_configure() is called.

Warning

Internal use only.

kivy.kivy_shader_dir = '/home/runner/work/kivy/kivy/kivy/data/glsl'

Kivy glsl shader directory

kivy.kivy_usermodules_dir = ''

Kivy user modules directory

kivy.parse_kivy_version(version)

Parses the kivy version as described in require() into a 3-tuple of ([x, y, z], ‘rc|a|b|dev|post’, ‘N’) where N is the tag revision. The last two elements may be None.

kivy.require(version)

Require can be used to check the minimum version required to run a Kivy application. For example, you can start your application code like this:

import kivy
kivy.require('1.0.1')

If a user attempts to run your application with a version of Kivy that is older than the specified version, an Exception is raised.

The Kivy version string is built like this:

X.Y.Z[tag[tagrevision]]

X is the major version
Y is the minor version
Z is the bugfixes revision

The tag is optional, but may be one of ‘.dev’, ‘.post’, ‘a’, ‘b’, or ‘rc’. The tagrevision is the revision number of the tag.

Warning

You must not ask for a version with a tag, except -dev. Asking for a ‘dev’ version will just warn the user if the current Kivy version is not a -dev, but it will never raise an exception. You must not ask for a version with a tagrevision.

• NO DOCUMENTATION (module kivy.uix.recycleview)
• Animation
  • Simple animation
  • Multiple properties and transitions
  • Sequential animation
  • Parallel animation
  • Repeating animation
• Application
  • Creating an Application
    • Method using build() override
    • Method using kv file
  • Application configuration
    • Use the configuration file
    • Create a settings panel
  • Profiling with on_start and on_stop
  • Customising layout
  • Pause mode
  • Asynchronous app
    • Background
    • Async configuration
  • Interacting with Kivy app from other coroutines
• Asynchronous data loader
  • Tweaking the asynchronous loader
• Atlas
  • Definition of .atlas files
  • How to create an Atlas
  • How to use an Atlas
  • Manual usage of the Atlas
• Cache manager
• Clock object
  • Schedule before frame
  • Triggered Events
  • Unscheduling
  • Clock Lifecycle
  • Exception Handling
  • Scheduling from __del__
  • Threading and Callback Order
  • Advanced Clock Details
    • Default Clock
    • Interruptible Clock
    • Free Clock
    • Free Only Clock
    • Summary
  • Async clock support
• Compatibility module for Python 2.7 and >= 3.4
• Configuration object
  • Applying configurations
  • Usage of the Config object
  • Changing configuration with environment variables
  • Available configuration tokens
• Context
• Event dispatcher
• Factory object
• Geometry utilities
• Gesture recognition
• Interactive launcher
  • Creating an InteractiveLauncher
  • Interactive Development
  • Directly Pausing the Application
  • Adding Attributes Dynamically
    • TODO
• Kivy Base
• Logger object
  • Example Usage
  • Features
  • Logger Configuration
  • Logger History
• Metrics
  • Dimensions
  • Examples
  • Manual control of metrics
• Multistroke gesture recognizer
  • Conceptual Overview
  • Usage examples
  • Algorithm details
• Parser utilities
• Properties
  • Comparison Python vs. Kivy
    • Basic example
    • Depth being tracked
    • Value checking
    • Error Handling
    • Keyword arguments and __init__()
    • Conclusion
  • Observe Property changes
    • Observe using bind()
    • Observe using ‘on_<propname>’
  • Binding to properties of properties.
• Resources management
  • Resource lookup
  • Customizing Kivy
• Support
• Utils
• Vector
  • Optimized usage
  • Vector operators
• Weak Method
• Weak Proxy

« API Reference

NO DOCUMENTATION (module kivy.uix.recycleview) »