Skip to main content

Decorator-based CLI framework with rich output

Project description

philiprehberger-cli-builder

Tests PyPI version License

Decorator-based CLI framework with rich output.

Install

pip install philiprehberger-cli-builder

Usage

from philiprehberger_cli_builder import CLI, arg, option

cli = CLI(name="myapp", version="1.0.0")

@cli.command()
@arg("name", help="Your name")
@option("--greeting", "-g", default="Hello", help="Greeting to use")
def greet(name: str, greeting: str):
    """Greet someone by name."""
    cli.success(f"{greeting}, {name}!")

@cli.command()
@option("--format", "-f", default="table", choices=["json", "table"])
def status(format: str):
    """Show system status."""
    data = [{"service": "api", "status": "up"}, {"service": "db", "status": "up"}]
    if format == "json":
        cli.json(data)
    else:
        cli.table(data, headers=["Service", "Status"])

cli.run()

Output Helpers

cli.success("Done!")       # ✓ Done!
cli.error("Failed")       # ✗ Failed
cli.warn("Careful")       # ! Careful
cli.info("Note")          # ℹ Note
cli.json(data)            # Pretty-printed JSON
cli.table(data, headers)  # Rich table
cli.progress(items)       # Progress bar

Decorators

Decorator Description
@cli.command() Register a command
@arg(name) Positional argument
@option(--name, -n) Named option with optional short form

License

MIT

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

philiprehberger_cli_builder-0.1.3.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

philiprehberger_cli_builder-0.1.3-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_cli_builder-0.1.3.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_cli_builder-0.1.3.tar.gz
Algorithm Hash digest
SHA256 f118246a7084bdb1878b7fcf7715dedf5c48697ed82461c181e189acd4192d59
MD5 4f04415b08dade4ec08127aa73be6d68
BLAKE2b-256 273937d3c903f4e06718883a03654341b877374b596ba7551e66ae7c8302b66c

See more details on using hashes here.

File details

Details for the file philiprehberger_cli_builder-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_cli_builder-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ce064f68bc7917fbeb488e30083efaebeab0c6381857eeb94e06e5cf1206ea33
MD5 26017c80be103843e63a2914cfaedffd
BLAKE2b-256 2f37a8a3f34c3221510611d6ccf142fc616d0d09194a47f2094bc1e136f968ff

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