This repository contains a set of helper scripts designed to streamline the development of KivyMD applications. These scripts assist in creating template applications, structuring files, and setting up a development environment conducive for KivyMD.
- Features 🌟
- Prerequisites 🔍
- Installation ⚙️
- Usage 🚀
- Script Descriptions 📝
- Contributing 👥
- License 📜
- Template Creation: Generate basic templates for KivyMD applications, allowing you to kickstart your project.
- File Structuring: Organize your files in a recommended structure, ensuring maintainability and clarity.
- KivyMD Setup: Quick setup scripts for KivyMD dependencies and configurations.
Before using these scripts, ensure you have the following installed:
- Python (>= 3.7) 🐍
- pip 📦
- Kivy 🎨
- KivyMD 📱
-
Clone this repository:
git clone https://github.com/yourusername/kivymd-helper-scripts.git
-
Navigate to the repository directory:
cd kivymd-helper-scripts
-
(Optional) Create a virtual environment to keep dependencies managed:
python -m venv venv source venv/bin/activate
On Windows, use
venv\Scripts\activate
-
Install the required dependencies:
pip install -r requirements.txt
To use a script, run it with Python:
- create_template.py: Generates a basic KivyMD application template. Use the
--name
option to specify the app's name. - structure_files.py: Organizes your project files. Ensure you're in the project's root directory before executing.
- setup_kivymd.py: Sets up necessary dependencies and configurations for KivyMD.
If you find any bugs, have suggestions or want to improve these scripts, feel free to create an issue or pull request.
This project is licensed under the MIT License. See the LICENSE file for details.