Skip to content

Installation

Video Install Guide

Learn how to install Kivy Reloader on your project with all the necessary dependencies.

Prerequisites

You must have followed our installation guide and you must have the basic tools and know how to use them:

  • Poetry
  • Pyenv
  • Git
  • Scrcpy

Install Scrcpy

You must install scrcpy on your computer. It comes with adb, so you don't need to install it separately. Choose the installation guide according to your operating system:

  • Linux. On Ubuntu, DO NOT install it with sudo apt install scrcpy. Please, follow the latest release instructions. Kivy Reloader is not compatible with the obsolete version of scrcpy that comes with apt.
  • macOS

Using scrcpy you will be able to control your Android phone from your computer.

Start the Poetry Wizard

Start a poetry project with the following command and follow the wizard instructions.

$ poetry init

After the wizard is finished, the pyproject.toml file will be created in the current directory.

Activate the virtual environment

Type poetry shell on the terminal and press enter.

$ poetry shell

Install the dependencies

Install the dependencies by typing poetry add kivy-reloader on the terminal and press enter.

$ poetry add kivy-reloader

Configure the Kivy Reloader:

After installing kivy-reloader, follow our setup and how to use guide to configure your project and learn how to use Kivy Reloader.