https://github.com/aidinhamedi/python-cli-template

This is a Python-based Command Line Interface (CLI) template. It's designed to be interactive and user-friendly, providing a variety of commands for users to interact with the system. You can customize this template to suit your needs by modifying the global variables, helper functions, and command functions.
https://github.com/aidinhamedi/python-cli-template

cli colorful interface python python3 template

Last synced: 9 months ago
JSON representation

This is a Python-based Command Line Interface (CLI) template. It's designed to be interactive and user-friendly, providing a variety of commands for users to interact with the system. You can customize this template to suit your needs by modifying the global variables, helper functions, and command functions.

• Host: GitHub
• URL: https://github.com/aidinhamedi/python-cli-template
• Owner: AidinHamedi
• License: mit
• Created: 2023-09-29T10:25:49.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-11T08:40:46.000Z (almost 2 years ago)
• Last Synced: 2024-11-26T15:50:20.300Z (about 1 year ago)
• Topics: cli, colorful, interface, python, python3, template
• Language: Python
• Homepage:
• Size: 1.47 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Python CLI Template



[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This project is a template for a Python Command Line Interface (CLI) application. It includes a cmd file that checks the Python version, installs packages, and more. The Python file is a colorful CLI template that you can easily add commands to and customize. It includes some base commands as well.

The CLI also includes error handling, which can provide detailed error messages when something goes wrong.

### Example usage:

![Example](Screenshot.png)  

> **Note**\

>  Please note that this image is for a project using the template.

>  **Note**\

>  Please note that this code uses my print_color\

>  for more info go to https://github.com/Aydinhamedi/Python-color-print.

>  **Note**\

>  Please note that there is a new toolkit version\

>  more info on https://github.com/Aydinhamedi/Python-CLI-toolkit.

>  **Warning**\

>  Please note that a part of this doc is generated by Ai (GPT-4).

> ### [Usage Documentation(doc.md)](doc.md) / [Usage Documentation(wiki)](https://github.com/Aydinhamedi/Python-CLI-template/wiki)

## Features

- Python version check

- Package installation

- Easy command addition and customization

- Colorful CLI interface

- Base commands included

- Error handling

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

- Python 3.x

### Installation

1. Clone the repo

   ```sh

   git clone https://github.com/Aydinhamedi/Python-CLI-template

   ```

## Usage

After installation, you can run the CLI application with the `CLI.cmd` and customize the CLI with `Data\CLI_main.py` file

This will start the CLI application where you can use the available commands.

## License

Distributed under the MIT License. See `LICENSE` for more information.