Skip to main content

Decorator-based CLI framework with rich output

Project description

philiprehberger-cli-builder

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.2.tar.gz (4.5 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.2-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_cli_builder-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9f3132a53ada5f8c112035abdafba541d5a10ea551f5ada53d0ed1dadffaa3b0
MD5 b47c39c5cf2e88147728592f13e1e4c1
BLAKE2b-256 12a5d8a99abd48082c421106052bf2a6623e7f35432c750785eeefd6fc71911a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_cli_builder-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f41d5c584260e778f830d95503a552a258fd099b37e1db1adfc306eb18c03a37
MD5 acaa902839c9622721bc79c6cddb987a
BLAKE2b-256 2e2709a52323bf98e0ef5bac8b979236eb47dc1484ab2b39deaf5f4dc9480f9e

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