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.11.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

termkit-0.2.11-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: termkit-0.2.11.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.6 Linux/5.15.0-84-generic

File hashes

Hashes for termkit-0.2.11.tar.gz
Algorithm Hash digest
SHA256 6c33b5c389212f070000c96926ee49d431c990e8b88aafc8420d797c8377cd66
MD5 335e0088cf1cffd12812fe3f9dc54448
BLAKE2b-256 bdb551701390c58f38d31bc4e598d8831b74b660e18435a15490f7a034f5fb7a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: termkit-0.2.11-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.6 Linux/5.15.0-84-generic

File hashes

Hashes for termkit-0.2.11-py3-none-any.whl
Algorithm Hash digest
SHA256 a5141305b079d19912b2d10eb28b34bb26cbec179a2bd24b091e1cf4cf35d04b
MD5 102fa3435c5a281beb2ac08118ea9a4f
BLAKE2b-256 282dab3f00424e565031e745510430fb05322d558fd25abaf38ed22cb6dd9196

See more details on using hashes here.

Supported by

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