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.0.tar.gz (4.4 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.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_cli_builder-0.1.0.tar.gz
Algorithm Hash digest
SHA256 11eba86190cc706ce08914de6582d6034fd2b56ef2021711c9e66d3a16bdb0f8
MD5 aaedde965dabddefe6367888c975f521
BLAKE2b-256 b365584f08594e934cdf9b6b3b9dd1d4ef25aed85f768b683da414bf6e45e1b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_cli_builder-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a8b3f6fa5eaccf2389b2d5781680e560424d397149dea2cb9f017b855df9ff2b
MD5 5dc4633993181b80305d0c7b760312af
BLAKE2b-256 36880044bc5b78d633fdd93518cb4ec4968eeb90aab7ee3423e19ef0565a0136

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