arg-kiss — Keep It Stupidly Simple CLI builder on top of argparse
Project description
arg-kiss — Keep It Stupidly Simple CLI builder on top of argparse
Write type-annotated Python functions, get a CLI with argparse's native --help — no magic, no bloat.
✨ Features
- Zero Dependencies — Pure stdlib:
argparse,asyncio,inspect - Type-Driven — Automatic arguments from function signatures and type hints
- Async-Native —
async defhandlers with automatic event loop management - Bool Flags — Automatic
--name/--no-namemutually exclusive group - Command Groups — Nested subcommands via
cli.group() - Standard --help — Clean argparse output, nothing custom
- Colour Output — Optional coloured error messages and help text
🚀 Quick Start
Installation
pip install arg-kiss
Usage
from arg_kiss import CLI
cli = CLI(name="todo", description="Task manager", colour=True)
@cli.command()
def add(task: str, priority: int = 1, done: bool = False):
"""Add a task."""
status = "✓" if done else "○"
print(f"[{status}] {task} (priority: {priority})")
cli.run()
$ python todo.py --help
usage: todo [-h] {add} ...
Task manager
options:
-h, --help show this help message and exit
Commands:
{add}
add Add a task.
$ python todo.py add --help
usage: todo add [-h] [--priority PRIORITY] [--done | --no-done] task
Add a task.
positional arguments:
task
options:
-h, --help show this help message and exit
--priority PRIORITY (default: 1)
--done Enable done
--no-done Disable done
📋 API Reference
CLI class
CLI(name="myapp", description="Description", colour=True)
| Parameter | Type | Default | Description |
|---|---|---|---|
name |
str |
None |
Program name |
description |
str |
None |
Program description |
version |
str |
None |
Adds --version flag |
colour |
bool |
True |
Enable/disable coloured output (errors, help text) |
Type → CLI Mapping
| Function Signature | CLI Argument |
|---|---|
name: str |
Positional name |
count: int = 1 |
--count 1 |
verbose: bool = False |
--verbose / --no-verbose |
mode: str | None = None |
--mode MODE |
🎨 Colour Support
The colour parameter controls coloured output:
- Error messages — Displayed in red with helpful hints
- Help text — Syntax highlighting for usage, options, and commands
- Respects NO_COLOR — Automatically disabled when
NO_COLORenv var is set
# Disable colours globally
cli = CLI(name="myapp", colour=False)
# Or via environment variable
export NO_COLOR=1
📖 Examples
Multiple Commands
from arg_kiss import CLI
cli = CLI(name="db", description="Simple database", colour=True)
db = {}
@cli.command()
def set(key: str, value: str):
"""Store a value."""
db[key] = value
print(f"OK: {key} = {value}")
@cli.command()
def get(key: str):
"""Retrieve a value."""
print(db.get(key, "Not found"))
@cli.command()
def delete(key: str, force: bool = False):
"""Delete a key."""
if force or key in db:
db.pop(key, None)
print(f"Deleted: {key}")
else:
print(f"Not found (use --force)")
cli.run()
$ python db.py --help
usage: db [-h] {set,get,delete} ...
Simple database
options:
-h, --help show this help message and exit
Commands:
{set,get,delete}
set Store a value.
get Retrieve a value.
delete Delete a key.
$ python db.py set hello world
OK: hello = world
$ python db.py get hello
world
Command Groups
cli = CLI(name="git", description="Version control")
remote = cli.group("remote", "Manage remotes")
stash = cli.group("stash", "Stash changes")
@remote.command()
def add(name: str, url: str):
"""Add a remote."""
print(f"Added remote {name} -> {url}")
@stash.command()
def push(message: str = ""):
"""Stash changes."""
print(f"Stashed: {message or 'WIP'}")
cli.run()
$ python git.py --help
usage: git [-h] {remote,stash} ...
Version control
options:
-h, --help show this help message and exit
Commands:
{remote,stash}
remote Manage remotes
stash Stash changes
$ python git.py remote --help
usage: git remote [-h] {add} ...
options:
-h, --help show this help message and exit
Subcommands:
{add}
add Add a remote.
$ python git.py remote add origin https://github.com/user/repo
Added remote origin -> https://github.com/user/repo
Async Commands
@cli.command()
async def fetch(url: str, retries: int = 3):
"""Fetch a URL."""
import httpx
async with httpx.AsyncClient() as client:
r = await client.get(url)
print(f"Status: {r.status_code}")
❓ FAQ
Bool flags?
Automatic --name/--no-name mutually exclusive group with store_true/store_false.
Async?
async def handlers auto-run with asyncio.run().
Colours?
Set colour=False to disable, or use NO_COLOR environment variable.
📄 License
MIT — see LICENSE file.
Author: Fkernel653
Repository: github.com/Fkernel653/arg-kiss
PyPI: pypi.org/project/arg-kiss
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file arg_kiss-0.2.1.tar.gz.
File metadata
- Download URL: arg_kiss-0.2.1.tar.gz
- Upload date:
- Size: 6.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5e5ae52e1474f605a09cf3c2e3002ce7532cdb410d85d67425fcbf0e8f7481ac
|
|
| MD5 |
85b6ca847af2521bcafc301e6e4747b8
|
|
| BLAKE2b-256 |
a43acb4639a8d95529ce6556aa5d6937b82c3cdae1c9da2737a0ac11c1441e46
|
File details
Details for the file arg_kiss-0.2.1-py3-none-any.whl.
File metadata
- Download URL: arg_kiss-0.2.1-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d179bd63882d35a94764fef930963d28786dab9294bf274cffcfd2042d9b8eed
|
|
| MD5 |
359bef1e0e7446df7f0f10a8257ba9ab
|
|
| BLAKE2b-256 |
8a7b219ade85aae4c2961d9550d533aa1d7c7a7d378b438b0a08b262ca87c887
|