Command Line Interface Mate (CLImate) [WIP]
Table of Contents
About
CLImate is a series of tools for creating understandable, easy to use, command line apps in Python.
The goal of CLImate is to have it handle I/O and some state so that users are aware of what is going on inside your script. While there are other libraries out there for making CLIs in Python, CLImate is aimed toward apps that require limited user interaction, rather, those which could benefit from updating the user as code executes. Rather than displaying a blank screen as execution is happening, apps will be able to keep the user informed and log events in a standard manner.
Getting Started
CLImate is still incredibly under development, so there are no usage instructions for the library, however, you can check out the demo of the components that are implemented or poke around in the source.
Installing and Running
All that's needed to start using to contributing to CLImate is Python3
First, clone this repo
git clone https://github.com/AaronCGoidel/CLImate.git
Then, you can start contributing
OR
Run the demo
python3 demo.py
Contributing
CLImate is very seriously a work in progress. Any help, interaction, and input is welcome and encouraged. Feel free to make any contributions, whether it be typos, documentation, new features, bug fixes, etc. Suggest features and functionality, open PRs and issues, or tackle any of the open issues.
License
This project is licensed under the BSD 3 Clause License, the details for which can be found in the LICENSE file