termkit 0.3.0

Introduction

Termkit is a Python framework designed for building command line interface applications using functions and type hints [PEP 484]. Solely written using Python Standard Library and will always be to ensure minimal dependency footprint within your project.

Features

• Build CLI Tools from functional code
• Create fast prototypes using implicit arguments
• Compatible with argcomplete for autocompletion

Usage

To get started, follow these steps:

1. Install Termkit using pip

$ pip install termkit

2. Test it with given example

# app.py
from termkit import Termkit

app = Termkit()

@app.command()
def greet(name, count=2):
    for _ in range(count):
        print(name)

if __name__ == "__main__":
    app()

$ python3 ./app.py "Hello Termkit" --count 3
Hello Termkit
Hello Termkit
Hello Termkit

Work in Progress Disclaimer

🛠️ Please Note: This documentation is a work in progress. 🛠️

Termkit is constantly evolving, and we are actively working on expanding and improving this documentation. Some sections may be incomplete or subject to change. We appreciate your patience and understanding as we continue to enhance this resource.

If you have any questions or encounter any issues while using Termkit, please feel free to reach me at contact@tmahe.dev.

Thank you for being a part of Termkit journey! 🌟