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.12.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.12-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: termkit-0.2.12.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.12.tar.gz
Algorithm Hash digest
SHA256 b3d409d8f958c8b0b88db629d23cbefdb42bf974aa0fccd347f117213be037d6
MD5 c73d7369b7965ad42b0b8de6c627deb7
BLAKE2b-256 96a1971c767af0fbb4d93b3abcae466601d8b971e7d1468496bf23407aae6a21

See more details on using hashes here.

File details

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

File metadata

  • Download URL: termkit-0.2.12-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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 003805dcf7b7c5e3478d35dbafa24d8a8f9a96d8bede471166566e3f26f424e0
MD5 0abbbe57dbcabca63ded96662621b782
BLAKE2b-256 77946e72e747380eed8096ead0ee82fe5b0c209a9289503759a707cc18842960

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