Skip to content

Home

Jump to bottom
Kartavya Shukla edited this page Mar 9, 2025 · 2 revisions

🚀 Welcome to KvDeveloper's Wiki

Introduction

KvDeveloper is a CLI to manage Kivy and KivyMD applications. Inspired by Expo CLI for React Native, KvDeveloper provides starter templates and essential functionalities to kickstart your projects with ease. KvDeveloper is a powerful command-line tool designed to simplify and enhance the development experience for Kivy and KivyMD applications. It provides an intuitive workflow, prebuilt templates, live reloading, and automation for faster app development.

Whether you're a beginner or an experienced developer, this documentation will guide you through everything you need to know about using KvDeveloper efficiently.

📌 Key Features

  • Scaffold Kivy & KivyMD Apps with prebuilt templates
  • Inbuilt Live Hot Reloading for rapid development
  • Automated Commands to create screens, views, and structures
  • Prebuilt UI Components for quicker UI development
  • Easy APK Builds with automated workflow integration
  • Starter Templates: Quickly create new Kivy and KivyMD projects with predefined templates.
  • Layouts: Build standard screens rapidly with prebuilt designs. Add layouts to any screen with a single command, making the development process faster and more efficient.
  • MVC Structure: Includes templates with Model-View-Controller (MVC) architecture. (recommended KivyMD==2.0.1.dev0)
  • Navigation and Toolbar: Templates with built-in navigation and toolbar screens.
  • Customizable: Easily extend and customize the templates and layouts to fit your project needs.
  • Build Workflows and Jupyter Notebooks: Generates build workflows for github based conversions and jupyter notebooks for colab based converions.

📂 Documentation Structure

The KvDeveloper documentation is divided into several sections:

🛠Installation

  • Install KvDeveloper using pip:

    pip install kvdeveloper

    OR

    pip install kvdeveloper[all]

  • Install development version using pip (requires git installation):

    pip install git+https://github.com/Novfensec/KvDeveloper.git@main

    OR

    pip install https://github.com/Novfensec/KvDeveloper/archive/main.zip

💡 Quick Start

Create a new KivyMD project with a navigation toolbar template:

kvdeveloper create-app MyApp --template nav_toolbar

Add a new screen to your project:

kvdeveloper add-screen LoginScreen

Run your app with live preview:

main.py

🔗 Additional Resources

Next Steps

➡️ Getting Started →

Clone this wiki locally