Skip to main content

Python command line application framework

Project description

Command Line Tools with... ease.

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! 🌟

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

termkit-0.2.13.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

termkit-0.2.13-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file termkit-0.2.13.tar.gz.

File metadata

  • Download URL: termkit-0.2.13.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.8.0-49-generic

File hashes

Hashes for termkit-0.2.13.tar.gz
Algorithm Hash digest
SHA256 91817758daf46ffe11d4793b14d0628bc6850f2de21c042e430dfc0f8a023a6b
MD5 84fa4d5b67c360619f897a0ce56c7a8d
BLAKE2b-256 a98e2bb828763a4e1c030eb48aa3184259559c2850fd8c89a8871d98c8d1f9e1

See more details on using hashes here.

File details

Details for the file termkit-0.2.13-py3-none-any.whl.

File metadata

  • Download URL: termkit-0.2.13-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.8.0-49-generic

File hashes

Hashes for termkit-0.2.13-py3-none-any.whl
Algorithm Hash digest
SHA256 2dfaa67ddf050a8c680afad751cc68c595f40b78cfbff08650cf4bc4f2df04b4
MD5 f70c0593819cb4b04b443eae71ff64cc
BLAKE2b-256 4580654d350b6350b94e0903f4c50d4ec93c5b8c88352ee9c50434cfb5e3b4d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page