✓ KivyMD. TODO List

[ArtemSBulgakov]

TODO List

This is the list that contains all ideas about KivyMD. Please create issues with feature description if you really need it.

KivyMD library - components

kivymd/KivyMD repository

• Labels
  • MDLabel
  • MDIcon
    • Support for using standard sizes (like 32x, 48x)
    • Support for images inside MDIcon widget
    • Animation for icon changes
• Buttons
  • Material Design spec, Buttons
  • Material Design spec, Buttons: floating action button
  • Can we join all MD* buttons to one MDButton class?
    • May be use type property for different styles
• Text fields
  • Material Design spec, Text fields
  • Type: line
  • Type: filled
    • Round
      • Can we join MDTextFieldRound with MDTextField to use type property for changing style?
  • Type: outlined
• Selection controls
  • Checkbox
    • Make animation of checking/unchecking more like in specification
  • Radio button
  • Switch
• Cards
  • Material Design spec, Cards
  • Elevation on hover
  • Button behavior with ripple
• Search
  • Material Design spec, Search
• Chips
  • Material Design spec, Chips
• Dialogs
  • Material Design spec, Dialogs
• Dividers
  • Material Design spec, Dividers
• Data tables
  • Material Design spec, Data tables
  • https://gitlab.com/zuhaib/KivyMD/tree/feature/DataTable
• Image lists
  • Material Design spec, Image lists
• Lists
  • Material Design spec, Lists
• Menus
  • Material Design spec, Menus
• Navigation drawer
  • Material Design spec, Navigation drawer
• Pickers
  • Time picker
  • Date picker
• Progress indicators
  • Material Design spec, Progress indicators
• App bars
  • Material Design spec, App bars: top
  • Material Design spec, App bars: bottom
• Navigation bar
  • Material Design spec, Navigation bar
• Sheets
  • Material Design spec, Sheets: bottom
  • Material Design spec, Sheets: side
• Sliders
  • Material Design spec, Sliders
• Snackbars
  • Material Design spec, Snackbars
• Tabs
  • Material Design spec, Tabs
• Tooltips
  • Material Design spec, Tooltips
  • Direction of the tooltip (left/top/right/bottom)
  • Time delay before showing tooltip
  • Feature to show tooltip by function call, not by hover

KivyMD library - modules

• App
  • MDApp class that has theme manager object
• Toast
• Theming
  • Theme class
    • Fast theme changing
• Navigation
  • Material Design spec, Understanding navigation
  • Material Design spec, Navigation transitions
  • Function in MDApp that can automatically set animation of transition between screens (that depend on position of previous and next screen in the screen tree

Automation

• Auto formatting with Black
  • Checking formatting via GitHub Actions
• Script for making release
• Auto deploying to PyPI
• Signing packages published to PyPI
• Signing demos binaries
• Publish demos to Play Store (autopublishing)
• Tests for main modules
• Tests for demos
• Generation videos (gifs) and screenshots for documentation

Demos

• Make studies as individual demos
• Test mode for Kitchen Sink demo (runs all demo widgets)
• Add Readme for each app

Documentation

• Make one-style documentation for all modules
• Generating documentation for GitHub pages
• Documentation standards for KivyMD Extensions
• Documentation for developers

KivyMD Website

kivymd/website repository

• Collect all documentation (KivyMD, KivyMD Extensions) into one website
• Buy domain
• Publish development documentaion in dev subdomain
• Publish public keys in keys subdomain
• Make documentation using Material-UI (example)
• Connect translation system
• Make documentation as pdf
• Page with statistics
  • Website pages views
  • KivyMD library installs, downloads, clones
  • Extensions statistics
  • Discord server statistics
  • Other statistics
• Badges: kivymd-official, kivymd-internal, kivymd-extensions, kivymd-unofficial
  • Page where listed all projects with these badges
• Page with all links related to KivyMD

KivyMD Extensions

kivymd-extensions organization,
kivymd-extensions/KivyMD_Extensions repository,
kivymd-extensions/extension_template repository

• Workflow to check package structure
  • Don't allow to edit kivymd_extensions/__init__.py file
  • Check that there is __version__ in __init__.py
• Documentation for developers

KivyMD Template

kivymd/KivyMD_Template repository

• Create KivyMD_Template utility - generator for new apps/packages/extensions
• Create KivyMD_Template_Sample repository - template repository that user can just clone
• Command line interface (CLI)
• Graphical interface (GUI)
• Show list of commands that utility will run
• Show resulting file structure (before real creation)

Features:

• Setup settings
  • PyCharm settings (.idea directory)
  • Git (.gitignore, .gitattributes, pre-commit), branches
  • Tools: autoformatters, linters
  • Packaging tools (Buildozer, PyInstaller)
  • CI (GitHub Actions)
• Create screens
• Create asynchronous classes: connection with API (asynchronous loading),
• Customize theme

KivyMD Bot

kivymd/kivymd_bot repository

GitHub:

• Welcoming new contributors
• Pushing binaries, build website to kivymd/storage repository
• Pull request status in second comment
• Autolabeling, autoclosing, autolocking, autoassigning
• Storing keys, signing packages, posting packages to PyPI
• Marking donaters/sponsors
• Autohide private, illegal or spam messages
• Contacting sponsors to notify about their privileges
• Synchronizing labels among all KivyMD repositories

Discord:

• Welcoming new members (in direct message)
• Controlling rules
  • Duplicate messages
• Commands
  • Quick search in documentation
  • Instructions
• Posting GitHub updates
  • Edit message when comment has been edited on GitHub
  • Edit message with pull request status
• Autosetting roles (sponsors/extensions developers)
• Posting announcements about new releases

Development workflow

• Development in dev branch, latest release in main branch
• Structured labels
  • Scope: uix, tests, theming
  • Type: bug, enhancement; for KivyMD Extensions: new extension, extension request
  • Platform: android, ios, windows, linux, mac
  • Resolution: fixed, won't fix, rejected (for feature requests), out of date (already fixed in dev), duplicate, invalid
  • Priority: critical, high, normal, low
  • Bounty: has bounty; amount
  • Sponsoring level: donator, backer, gold sponsor
• Milestones
  • New releases
  • Large features
• Projects

Sponsoring

kivymd collective on OpenCollective

• Accepting cryptocurrency donations
• Automate bounty setting (if somebody sent a donation with message - issue id)

Design

• New color from Material palette that will be used for all our design
• New logo that fits Material style and can be exported as .svg
  • KivyMD
  • KivyMD Extensions
  • KivyMD Template
  • KivyMD Collection
  • KivyMD Bot
  • Social preview

Other

• Rebase KivyMD repository
  • Include old commits (currently all commits from older repositories are squashed into one)
  • Remove large files (replace them with empty file), decrease repository size
  • Fix commits author if there were any mistakes