Code Monkey home page Code Monkey logo

kivymd's Introduction

KivyMD

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 alpha 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

Full documentation yet. Some examples of using KivyMD widgets can be found in our Wiki and in the code of the demo applications

Support

If you need assistance, you can ask for help on our mailing list:

Installation and use with Buildozer

Dependencies:

  • Kivy version is not less than 1.10.1
  • PIL
  • Python 3 (Python 2 not supported)

How to install

To install KivyMD, clone the project and run the setup.py script. The following line works on Linux and Mac OS, other OSes not tested:

sudo python ./setup.py install

Replace "python" with the Python interpreter you want to install KivyMD on (Python 3 is supported)

How to use with Buildozer

If you want to use KivyMD with buildozer, in your buildozer.spec's requirements line you should add the full git HTTPS address, like this example:

requirements = kivy==master,git+https://github.com/HeaTTheatR/KivyMD.git

Running on Android

Android 6.0 and higher kitchen_sink-0.98.4-x86.apk or kitchen_sink-0.98.4-armeabi-v7a.apk

Download XUbuntu 18.04:

  • Create a new virtual machine based on the downloaded image of XUbuntu

  • Start the XUbuntu virtual machine, open the browser and download this bash script:

    Add execution permissions:

    chmod +x install-kivy-buildozer-dependencies.sh

    ...and run script:

    ./install-kivy-buildozer-dependencies.sh
  • Run the script - it 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

What's new in version 0.100.0:

CHANGELOG.md

API Breaking changes:

  • Moving classes to new modules:
Old New
kivymd.tabs.MDBottomNavigation kivymd.bottomnavigation.MDBottomNavigation
kivymd.updatespinner kivymd.refreshlayout
  • Renamed files, classes and variables:
Old New
kivymd.elevationbehavior kivymd.elevation
kivymd.grid kivymd.imagelists
kivymd.date_picker kivymd.pickers
kivymd.time_picker kivymd.pickers
kivymd.time_picker kivymd.pickers
kivymd.card kivymd.cards
kivymd.menu kivymd.menus
kivymd.snackbar kivymd.snackbars
Toolbar (from kivymd.toolbar) MDToolbar (from kivymd.toolbar)
  • Changed font styles:
Old New
Icon Icon
- Overline
Caption Caption
Button Button
Body2 Body2
Body1 Body1
- Subtitle2
Subhead Subtitle1
Title H6
Headline H5
Display1 H4
Display2 H3
Display3 H2
Display4 H1
  • Colors BlueGrey and Grey renamed to BlueGray and Gray (for better fit MD spec)

Video previous

Image previous

Sister project:

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

License

MIT, same as Kivy.

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

Material Design Iconic Font by Sergey Kupletsky covered by the licenses described at https://zavoloklom.github.io/material-design-iconic-font/license.html.

Icons by the materialdesignicons.com community covered by SIL OFL 1.1

kivymd's People

Contributors

heattheatr avatar homdx avatar artemsbulgakov avatar juacywillian avatar payala avatar mbogomazov avatar fox520 avatar gobig87 avatar vchertuk avatar akamoroz avatar germn avatar nitanmarcel avatar pigogames avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.