rich click

Antarmuka baris perintah yang ditampilkan dengan kaya dalam satu klik.

---

Dokumentasi · Kode Sumber · Changelog

---

rich-click adalah perubahan di sekitar Click yang menghasilkan keluaran bantuan dengan baik menggunakan Rich.

• Click adalah "paket Python untuk membuat antarmuka baris perintah yang indah" .
• Rich adalah "Perpustakaan Python untuk teks kaya dan pemformatan indah di terminal" .

Tujuan dari rich-click adalah untuk memberikan keluaran bantuan yang menarik dari Click, diformat dengan Rich, dengan sedikit penyesuaian yang diperlukan.

Fitur

• ? Pemformatan baris perintah yang kaya untuk bantuan klik dan pesan kesalahan
• ? API yang sama dengan Klik: penggunaannya cukup import rich_click as click
• ? Gaya yang bagus secara default
• Alat CLI untuk dijalankan pada alat orang lain (awalan perintah dengan rich-click )
• ? Ekspor teks bantuan sebagai HTML atau SVG
• ? Kelompokkan perintah dan opsi ke dalam panel bernama
• Pesan kesalahan yang diformat dengan baik
• ? Berikan urutan khusus untuk opsi dan perintah dengan mudah
• ? Penyesuaian gaya dan perilaku yang ekstensif dimungkinkan

Instalasi

pip install rich-click

Baca dokumen untuk semua metode instalasi yang didukung.

Contoh

Contoh Sederhana

Untuk menggunakan klik kaya dalam kode Anda, ganti import click dengan import rich_click as click di CLI klik Anda yang sudah ada:

 import rich_click as click

@ click . command ()
@ click . option ( "--count" , default = 1 , help = "Number of greetings." )
@ click . option ( "--name" , prompt = "Your name" , help = "The person to greet." )
def hello ( count , name ):
    """Simple program that greets NAME for a total of COUNT times."""
    for _ in range ( count ):
        click . echo ( f"Hello, { name } !" )

if __name__ == '__main__' :
    hello ()

Tangkapan layar dari examples/11_hello.py

Contoh yang lebih kompleks

Tangkapan layar dari examples/03_groups_sorting.py

Penggunaan

Ini adalah ikhtisar singkat tentang cara menggunakan klik kaya . Baca dokumen untuk informasi lebih lanjut.

Ada beberapa cara untuk mulai menggunakan rich-click :

Impor rich_click sebagai click

Ganti impor click normal Anda dengan rich_click , menggunakan namespace yang sama:

 import rich_click as click

Itu saja! Kemudian terus gunakan Klik seperti biasa.

Lihat examples/01_simple.py sebagai contoh.

Deklaratif

Jika mau, Anda dapat menggunakan RichGroup atau RichCommand dengan argumen cls dalam penggunaan klik Anda. Ini berarti Anda dapat terus menggunakan paket click yang tidak dimodifikasi secara paralel.

 import click
from rich_click import RichCommand

@ click . command ( cls = RichCommand )
def main ():
    """My amazing tool does all the things."""

Lihat examples/02_declarative.py sebagai contoh.

alat CLI rich-click

rich-click dilengkapi dengan alat CLI yang memungkinkan Anda memformat output bantuan Click dari paket apa pun yang menggunakan Click.

Untuk menggunakannya, awali rich-click ke perintah normal Anda. Misalnya, untuk memperkaya teks bantuan Click dari paket bernama awesometool , Anda dapat menjalankan:

$ rich-click awesometool --help

Usage: awesometool [OPTIONS]
..more richified output below.. 

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT.