Write type-annotated Python functions, get a CLI with argparse's native `--help` — no magic, no bloat
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.
🚀 Quick Start
pip install arg-kiss # Python 3.10+
from arg_kiss import Argkiss
cli = Argkiss(name="todo", description="Task manager", color=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.command()
def list_all():
"""Show all tasks."""
print("Nothing yet!")
cli()
$ python todo.py add "Buy milk" --priority 2
[○] Buy milk (priority: 2)
$ python todo.py list-all
Nothing yet!
$ python todo.py --help
usage: todo [-h] {add,list-all} ...
Task manager
positional arguments:
{add,list-all}
add Add a task.
list-all Show all tasks.
options:
-h, --help show this help message and exit
📋 Commands & Features
@cli.command() — Define commands from functions
@cli.command()
def fetch(url: str, retries: int = 3):
"""Download from URL with retries"""
print(f"Fetched {url} (retries: {retries})")
@cli.argument() — Customize argument flags
Use @cli.argument() above @cli.command() to customize flags, help text, and behavior for individual parameters.
@cli.argument("-u", "--user", help="Username")
@cli.argument("-p", "--port", type=int, default=8080, help="Port number")
@cli.argument("--ssl", action="store_true", help="Enable SSL")
@cli.command()
def connect(user: str, port: int = 8080, ssl: bool = False):
"""Connect to server"""
print(f"Connecting as {user} on port {port} (SSL: {ssl})")
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 |
Command groups
remote = cli.group("remote", "Manage remotes")
@remote.command()
def add(name: str, url: str):
print(f"Added remote {name} -> {url}")
Global arguments (apply to all commands)
cli.add_global_argument("--verbose", "-v", action="store_true", help="Verbose output")
cli.add_global_argument("--config", "-c", type=str, help="Config file path")
@cli.command()
def deploy(environment: str):
"""Deploy to environment."""
# Global arguments available in parsed namespace
pass
Async support
@cli.command()
async def fetch(url: str, retries: int = 3):
async with httpx.AsyncClient() as client:
r = await client.get(url)
print(f"Status: {r.status_code}")
🎨 CLI Configuration
cli = Argkiss(
name="myapp", # Program name (default: None)
description="Does amazing things", # Description in help (default: None)
version="2.0.0", # Adds --version flag (default: None)
color=False, # Disable ANSI colours (default: True)
)
| Option | Description |
|---|---|
name |
Program name in help (default: None) |
description |
Description in help (default: None) |
version |
Adds --version flag (default: None) |
color |
Enable/disable coloured output (default: True) |
Disable colours via environment
NO_COLOR=1 python myapp.py --help
📄 License & Acknowledgments
MIT License — Built with Python standard library:
| Module | Purpose |
|---|---|
argparse |
CLI parsing engine |
asyncio |
Async command execution |
inspect |
Signature introspection |
Author: Fkernel653 Project: GitHub • PyPI
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.3.0.tar.gz.
File metadata
- Download URL: arg_kiss-0.3.0.tar.gz
- Upload date:
- Size: 7.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","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 |
73cdc8fb92f60c22b7e9cf1c40e601dc81c50e73841adabc71bc4764aad47a38
|
|
| MD5 |
c15e5829076fd361bcd33f1fc6512ebf
|
|
| BLAKE2b-256 |
9ef47964a17ff26be9e61d6f1165d7b038109881a3c2b9f3acc7278bb8b1f868
|
File details
Details for the file arg_kiss-0.3.0-py3-none-any.whl.
File metadata
- Download URL: arg_kiss-0.3.0-py3-none-any.whl
- Upload date:
- Size: 8.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.22 {"installer":{"name":"uv","version":"0.11.22","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 |
1efc05861ba2739d7b777b4fd22868c8bda30ffa9e16dc2386fa5a709a06a83e
|
|
| MD5 |
f0b9bf2faae0649771ec6ed0306f9f56
|
|
| BLAKE2b-256 |
8e4065e01e2e8bdfadaff30a6501eaca97f315a1fc3ac9d39eee4ec996e95ab3
|