KivyMD

# KivyMD [2.0.0](https://kivymd.readthedocs.io/en/latest/changelog/index.html) KivyMD is a collection of Material Design compliant widgets for use with [Kivy](http://kivy.org), a framework for cross-platform, touch-enabled graphical applications. The project's goal is to approximate Google's [Material Design spec](https://material.io/design/introduction/) as close as possible without sacrificing ease of use. This library is a fork of the [KivyMD project](https://gitlab.com/kivymd/KivyMD). We found the strength and brought this project to a new level. 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. ## Installation ```bash pip install kivymd==2.0.0 ``` ### Dependencies: - [Kivy](https://github.com/kivy/kivy) >= 2.3.0 ([Installation](https://kivy.org/doc/stable/gettingstarted/installation.html)) - [Python 3.7+](https://www.python.org/) - [Pillow](https://github.com/python-pillow/Pillow/) - [PyCairo](https://github.com/pygobject/pycairo) ([Installation](https://pycairo.readthedocs.io/en/latest/getting_started.html#getting-started)) - [MaterialColor](https://github.com/T-Dynamos/materialyoucolor-python) >= 3.0.3 - [MaterialShapes](https://github.com/T-Dynamos/materialshapes-python) - [asynckivy](https://github.com/asyncgui/asynckivy) ### How to install Command [above](#installation) will install latest release version of KivyMD from [PyPI](https://pypi.org/project/kivymd). If you want to install development version from [master](https://github.com/kivymd/KivyMD/tree/master/) branch, you should specify link to zip archive: ```bash pip install https://github.com/kivymd/KivyMD/archive/master.zip ``` **_Tip_**: Replace `master.zip` with `.zip` (eg `51b8ef0.zip`) to download KivyMD from specific commit. Also you can install manually from sources. Just clone the project and run pip: ```bash 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 1.14 GiB), 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](https://github.com/kivy/buildozer) ```ini requirements = python3, kivy, https://github.com/kivymd/KivyMD/archive/master.zip, materialyoucolor==3.0.3, materialshapes, pycairo, pillow, exceptiongroup, asyncgui, asynckivy, android ``` This will download latest release version of KivyMD from [PyPI](https://pypi.org/project/kivymd). If you want to use development version from [master](https://github.com/kivymd/KivyMD/tree/master/) branch, you should specify link to zip archive: ```ini requirements = kivy, 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](https://github.com/kivy/buildozer#installing-buildozer-with-target-python-3-default) or via [Docker](https://github.com/kivy/buildozer/blob/master/Dockerfile). #### On Windows 10 - Install [Ubuntu WSL](https://ubuntu.com/wsl) and follow [Linux steps](#On-Linux). #### Build automatically via GitHub Actions - Use [ArtemSBulgakov/buildozer-action@v1](https://github.com/ArtemSBulgakov/buildozer-action) to build your packages automatically on push or pull request. - See [full workflow example](https://github.com/ArtemSBulgakov/buildozer-action#full-workflow). ### How to use with [kivy-ios](https://github.com/kivy/kivy-ios) ```bash toolchain build python3 kivy pillow toolchain pip install --no-deps kivymd ``` ## Documentation - See documentation at https://kivymd.readthedocs.io - Wiki with examples of using KivyMD widgets: https://github.com/kivymd/KivyMD/wiki ### Demos

[Kitchen sink](https://github.com/kivymd/KitchenSink) app demonstrates every KivyMD widget. You can see how to use widget in code of app. ### Comparison of Flutter & KivyMD | Sky View Concept | Healthy Food Delivery | :-------------------------:|:-------------------------: | | Asics Shoes Concept | Facebook Desktop Redesign | | ## Use MVC and Hot Reload

## 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](https://stackoverflow.com/tags/kivymd) - **Email:** [email protected] ## Settings #### [Syntax highlighting and auto-completion for Kivy/KivyMD .kv files in PyCharm/Intellij IDEA](https://github.com/noembryo/KV4Jetbrains) ## Promo Video

## Contributing We always welcome your [Bug reports](https://github.com/kivymd/KivyMD/issues/new?template=bug_report.md), [Feature requests](https://github.com/kivymd/KivyMD/issues/new?template=feature_request.md) and [Pull requests](https://github.com/kivymd/KivyMD/pulls)! Check out [CONTRIBUTING.md](https://github.com/kivymd/.github/blob/master/.github/CONTRIBUTING.md) and feel free to improve KivyMD. ### Setup environment We recommend you to use PyCharm to work with KivyMD code. Install [Kivy](https://kivy.org/doc/stable/gettingstarted/installation.html) and development dependencies to your virtual environment: ```bash pip install -e .[dev,docs] pre-commit install ``` Format all files and run tests: ```bash pre-commit run --all-files pytest kivymd/tests --timeout=600 --cov=kivymd --cov-report=term ``` pre-commit will format modified files with Black and sort imports with isort. ## Sister projects ## KivyMD Extensions Additional extensions for the KivyMD library. https://github.com/kivymd-extensions ## KivyMDBuilder Build apps visually. https://github.com/kivymd/KivyMDBuilder ## License - KivyMD is released under the terms of the [MIT License](https://github.com/kivymd/KivyMD/blob/master/LICENSE), same as [Kivy](https://github.com/kivy/kivy/blob/master/LICENSE). - [Roboto font](https://fonts.google.com/specimen/Roboto) is licensed and distributed under the terms of the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). - [Iconic font](https://github.com/Templarian/MaterialDesign-Webfont) by the [Material Design Icons](https://materialdesignicons.com/) community covered by [SIL Open Font License 1.1](http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web) ## Contributors ### KivyMD Team They spent a lot of time to improve KivyMD. - Yuri Ivanov [@HeaTTheatR](https://github.com/HeaTTheatR) - Core developer - Artem Bulgakov [@ArtemSBulgakov](https://github.com/ArtemSBulgakov) - Technical administrator, contributor - Andrés Rodríguez [@mixedCase](https://github.com/mixedCase) - First author of KivyMD project, contributor ### Code Contributors This project exists thanks to all the people who contribute. *[How to contribute](#Contributing)* ### Financial Contributors [Become a financial contributor](https://opencollective.com/kivymd#section-contribute) on OpenCollective and help us sustain our community. #### Gold Sponsors [Become a Gold Sponsor](https://opencollective.com/kivymd/contribute/gold-sponsor-16160) and get your logo on our Readme with a link to your website. | Peter Šurda | Route4Me Route Planner | :-------------------------:|:-------------------------: | #### Backers [Become a Backer](https://opencollective.com/kivymd/contribute/backer-16159) if you want to help develop this project.