Skip to main content

more beautiful Typer

Project description

Rich Typer

介绍

本项目是将Rich和Typer结合在一起,将CLI打造的更加美观漂亮。

安装

pip install rich_typer

或者使用poetry 安装

git clone https://github.com/Elinpf/rich_typer
cd rich_typer
poetry build
pip install dist/<whl_file>

使用

完全兼容Typer语法,具体语法细节参考Typer官方文档

除此之外增加了如下几个参数:

  • banner 增加标题
  • banner_justify 标题位置
  • epilog_blend 底部信息的渐变色
  • usage 自定义Usage

Example

from rich_typer import RichTyper, Argument, Option


app = RichTyper()
banner = f"[b]Rich Typer[/b] [magenta][/] 🤑\n\n[dim]将 Rich 与 Typer 结合起来,使界面更加漂亮。\n"

url = "♥ https://github.com/Elinpf/rich_typer"


@app.command(banner=banner, banner_justify='center', epilog=url)
def main(
    name: str = Argument(...,
                         help="Name of the [green]person to greet[/]."),
    message: str = Option('ms', '-m', '--message',
                                help="The message [red]to[/] display"),
    version: bool = Option(False, '-v', '--version',
                           help="Show the [u]version[/] and exit"),
) -> None:
    """[bold][blue]Rich Typer[/] example."""
    ...


app()

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

rich_typer-0.1.7.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

rich_typer-0.1.7-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file rich_typer-0.1.7.tar.gz.

File metadata

  • Download URL: rich_typer-0.1.7.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.7.13 Linux/5.15.0-1019-azure

File hashes

Hashes for rich_typer-0.1.7.tar.gz
Algorithm Hash digest
SHA256 07caca4f38a0e5c7f7ee6bc2b32f51e0b65a39a74a25cad7b9bef7e7ed7bf007
MD5 d853922976c2554f56553d161f9ce3c5
BLAKE2b-256 31a200f783e2491da079319a4587ad40ca0e495e71be00fd0f9885e0a46c8b37

See more details on using hashes here.

File details

Details for the file rich_typer-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: rich_typer-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.7.13 Linux/5.15.0-1019-azure

File hashes

Hashes for rich_typer-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 0cb66c0fa89e9d61d8fd248ff35f909102896f1e175d53132804d3a1e7cd6215
MD5 46a4f7306f535673ab13d6761838f4e5
BLAKE2b-256 598ae9683580099676d3ad640850e9e9b4de194400765001e8659e29f9674d4d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page