Skip to content

Latest commit

 

History

History
255 lines (181 loc) · 13.2 KB

README.md

File metadata and controls

255 lines (181 loc) · 13.2 KB
Raw

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.

PyPI version Supported Python versions Downloads Code style: Black

Discord Twitter YouTube Habr StackOverflow Open Collective

Coverage status Build workflow Test workflow Build demos workflow Documentation status

Documentation

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

Wiki with examples of using KivyMD widgets: https://github.com/HeaTTheatR/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:

Installation

Dependencies:

How to install

You can install latest release version of KivyMD from PyPI:

python3 -m pip install kivymd

If you want to install development version from master branch, you should specify git HTTPS address:

# Master branch:
python3 -m pip install git+https://github.com/HeaTTheatR/KivyMD.git
# Specific branch:
python3 -m pip install git+https://github.com/HeaTTheatR/KivyMD.git@stable
# Specific tag:
python3 -m pip install git+https://github.com/HeaTTheatR/KivyMD.git@0.100.2
# Specific commit:
python3 -m pip install git+https://github.com/HeaTTheatR/KivyMD.git@f80d9c8b812d54a724db7eda30c4211d0ba764c2

# If you already has installed KivyMD
python3 -m pip install --force-reinstall git+https://github.com/HeaTTheatR/KivyMD.git

Also you can install manually from sources. Just clone the project and run the setup.py script:

python3 ./setup.py install

Speed Tip: If you don't need full commit history, you can use a shallow clone (git clone git@github.com:HeaTTheatR/KivyMD.git --depth 1) to save time.

How to use with Buildozer

requirements = kivy==1.11.1, kivymd

This will download latest release version from PyPI. If you want to use master branch, you should write the full git HTTPS address, like this example:

# Master branch:
requirements = kivy==1.11.1, git+https://github.com/HeaTTheatR/KivyMD.git
# Specific branch:
requirements = kivy==1.11.1, git+https://github.com/HeaTTheatR/KivyMD.git@master
# Specific tag:
requirements = kivy==1.11.1, git+https://github.com/HeaTTheatR/KivyMD.git@0.100.2
# Specific commit:
requirements = kivy==1.11.1, git+https://github.com/HeaTTheatR/KivyMD.git@f80d9c8b812d54a724db7eda30c4211d0ba764c2

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

Building with VM

Packages for Android are built according to the following instructions:

  • Download XUbuntu 18.04
  • Create a new virtual machine based on the downloaded image of XUbuntu
  • Start the XUbuntu virtual machine, download this bash script, add execution permissions and run script:
wget https://github.com/HeaTTheatR/KivyMD-data/raw/master/install-kivy-buildozer-dependencies.sh
chmod +x install-kivy-buildozer-dependencies.sh

./install-kivy-buildozer-dependencies.sh
  • Script will install all the necessary libraries and tools for creating packages for Android
  • Done! Now you have a virtual machine for building Kivy application packages!

Or see the instructions here.

Settings

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

API Breaking changes

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]