Comrad/client/KivyMD

KivyMD v0.104.1

KivyMD is a collection of Material Design compliant widgets for use with Kivy, a framework for cross-platform, touch-enabled graphical applications.

The project's goal is to approximate Google's Material Design spec as close as possible without sacrificing ease of use or application performance.

This library is a fork of the KivyMD project the author of which stopped supporting this project three years ago. We found the strength and brought this project to a new level.

Currently we're in beta status, so things are changing all the time and we cannot promise any kind of API stability. However it is safe to vendor now and make use of what's currently available.

Join the project! Just fork the project, branch out and submit a pull request when your patch is ready. If any changes are necessary, we'll guide you through the steps that need to be done via PR comments or access to your for may be requested to outright submit them.

If you wish to become a project developer (permission to create branches on the project without forking for easier collaboration), have at least one PR approved and ask for it. If you contribute regularly to the project the role may be offered to you without asking too.

Documentation

See documentation at https://kivymd.readthedocs.io

Wiki with examples of using KivyMD widgets: https://github.com/kivymd/KivyMD/wiki

Demos

Kitchen sink app demonstrates every KivyMD widget. You can see how to use widget in code of app. You can download apk for your smartphone (Android 6.0 and higher): data branch.

Tutorials on YouTube

Tutorials by Erik Sandberg show you how to create application with KivyMD and use its widgets.

Support

If you need assistance or you have a question, you can ask for help on our mailing list:

• Discord server: https://discord.gg/wu3qBST (English #support, Russian #ru-support)
• StackOverflow tag: kivymd
• Email: kivydevelopment@gmail.com

Installation

Dependencies:

• Kivy >= 1.10.1 (Installation)
• Python 3.6+ (Python 2 not supported)

How to install

pip install kivymd==0.104.1

Command above will install latest release version of KivyMD from PyPI.

If you want to install development version from master branch, you should specify link to zip archive:

pip install https://github.com/kivymd/KivyMD/archive/master.zip

Tip: Replace master.zip with <commit hash>.zip (eg 51b8ef0.zip) to download KivyMD from specific commit.

Also you can install manually from sources. Just clone the project and run pip:

git clone https://github.com/kivymd/KivyMD.git --depth 1
cd KivyMD
pip install .

Speed Tip: If you don't need full commit history (about 320 MiB), you can use a shallow clone (git clone https://github.com/kivymd/KivyMD.git --depth 1) to save time. If you need full commit history, then remove --depth 1.

How to use with Buildozer

requirements = kivy==1.11.1, kivymd==0.104.1

This will download latest release version of KivyMD from PyPI.

If you want to use development version from master branch, you should specify link to zip archive:

requirements = kivy==1.11.1, https://github.com/kivymd/KivyMD/archive/master.zip

Do not forget to run buildozer android clean or remove .buildozer directory before building if version was updated (Buildozer doesn't update already downloaded packages).

On Linux

Use Buildozer directly or via Docker.

On Windows 10

Install Ubuntu WSL and follow Linux steps.

On Windows without WSL

Install VirtualBox and follow steps from here.

Build automatically via GitHub Actions

Use ArtemSBulgakov/buildozer-action@v1 to build your packages automatically on push or pull request. See full workflow example.

Settings

Syntax highlighting and auto-completion for Kivy/KivyMD .kv files in PyCharm/Intellij IDEA

API Breaking changes

• Changed MDExpansionPanel panel creation
• Changed the use of the MDDropdownMenu
• Changed the use of the MDDropDownItem
• Changed the use of the MDDialog

Video preview

Image preview

Contributing

We always welcome your Bug reports, Feature requests and Pull requests! Check out CONTRIBUTING.md and feel free to improve KivyMD.

Setup environment

We recommend you to use PyCharm to work with KivyMD code. Install Kivy and development dependencies to your virtual environment:

pip install -e .[dev,docs]
pre-commit install

Format all files and run tests:

pre-commit run --all-files
pytest kivymd/tests --timeout=300 --cov=kivymd --cov-report=term

pre-commit will format modified files with Black and sort imports with isort.

Sister projects

• Creator Kivy Project - Wizard for creating a new project for applications written using the Kivy framework

License

KivyMD is released under the terms of the MIT License, same as Kivy.

Roboto font is licensed and distributed under the terms of the Apache License, Version 2.0.

Iconic font by the Material Design Icons community covered by SIL Open Font License 1.1

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]