Quick search

Controlling the environment

Many environment variables are available to control the initialization and behavior of Kivy.

For example, for restricting text rendering to PIL implementation:

$ KIVY_TEXT=pil python main.py

Environment variable can be set before importing kivy:

import os
os.environ['KIVY_TEXT'] = 'pil'
import kivy

Path control

New in version 1.0.7.

You can control the default directories where config files, modules, extensions, and kivy data are located.

KIVY_DATA_DIR
Location of the Kivy data, default to <kivy path>/data
KIVY_EXTS_DIR
Location of the Kivy extensions, default to <kivy path>/extensions
KIVY_MODULES_DIR
Location of the Kivy modules, default to <kivy path>/modules
KIVY_HOME

Location of the Kivy home. This directory is used for local configuration, and must be in a writable location.

Defaults to:
  • Desktop: <user home>/.kivy
  • Android: <android app path>/.kivy
  • iOS: <user home>/Documents/.kivy

New in version 1.9.0.

KIVY_SDL2_PATH

If set, the SDL2 libraries and headers from this path are used when compiling kivy instead of the ones installed system-wide. To use the same libraries while running a kivy app, this path must be added at the start of the PATH environment variable.

New in version 1.9.0.

Configuration

KIVY_USE_DEFAULTCONFIG
If this name is found in environ, Kivy will not read the user config file.
KIVY_NO_CONFIG
If set, no configuration file will be read or write, and no user configuration directory too.
KIVY_NO_FILELOG
If set, logs will be not print on a file
KIVY_NO_CONSOLELOG
If set, logs will be not print on the console

Restrict core to specific implementation

kivy.core try to select the best implementation available for your platform. For testing or custom installation, you might want to restrict the selector to a specific implementation.

KIVY_WINDOW

Implementation to use for creating the Window

Values: pygame, x11, sdl, egl_rpi

KIVY_TEXT

Implementation to use for rendering text

Values: pil, pygame, sdlttf

KIVY_VIDEO

Implementation to use for rendering video

Values: pygst, gstplayer, pyglet, ffmpeg, null

KIVY_AUDIO

Implementation to use for playing audio

Values: gstplayer, pygst, sdl, pygame

KIVY_IMAGE

Implementation to use for reading image

Values: pil, pygame, imageio, tex, dds, gif

KIVY_CAMERA

Implementation to use for reading camera

Values: videocapture, avfoundation, pygst, opencv

KIVY_SPELLING

Implementation to use for spelling

Values: enchant, osxappkit

KIVY_CLIPBOARD

Implementation to use for clipboard management

Values: pygame, dummy, android

Metrics

KIVY_DPI

If set, the value will be used for Metrics.dpi.

New in version 1.4.0.

KIVY_METRICS_DENSITY

If set, the value will be used for Metrics.density.

New in version 1.5.0.

KIVY_METRICS_FONTSCALE

If set, the value will be used for Metrics.fontscale.

New in version 1.5.0.

Graphics

KIVY_GLES_LIMITS

Whether the GLES2 restrictions are enforced (the default, or if set to 1). If set to false, Kivy will not be trully GLES2 compatible.

Following is a list of the potential incompatibilities that result when set to true.

Mesh indices If true, the number of indices in a mesh is limited to 65535
Texture blit When blitting to a texture, the data (color and buffer) format must be the same format as the one used at the texture creation. On desktop, the conversion of different color is correctly handled by the driver, while on Android, most of devices fail to do it. Ref: https://github.com/kivy/kivy/issues/1600

New in version 1.8.1.