click README

The project's README from github.com/pallets/click. As one markdown file: README.md.

Click

Click is a Python package for creating beautiful command line interfaces in a composable way with as little code as necessary. It's the "Command Line Interface Creation Kit". It's highly configurable but comes with sensible defaults out of the box.

It aims to make the process of writing command line tools quick and fun while also preventing any frustration caused by the inability to implement an intended CLI API.

Click in three points:

A Simple Example

import 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()
$ python hello.py --count=3
Your name: Click
Hello, Click!
Hello, Click!
Hello, Click!

Donate

The Pallets organization develops and supports Click and other popular packages. In order to grow the community of contributors and users, and allow the maintainers to devote more time to the projects, please donate today.

Contributing

See our detailed contributing documentation for many ways to contribute, including reporting issues, requesting features, asking or answering questions, and making PRs.

click (pallets/click)

Searching Database…

17.8K ·GitHub
Что это такое?Click — это Python-пакет для создания красивых интерфейсов командной строки компонуемым способом и с минимальным количеством кода. Его название расшифровывается как 'Command Line Interface Creation Kit' (набор для создания CLI).
Это утилита, которую я запускаю из терминала, или библиотека, которую я использую в своём коде?Это библиотека, а не приложение: вы импортируете её в свой Python-проект и пишете код с её помощью, чтобы создавать собственные программы с интерфейсом командной строки.
Как добавить её в свой проект?Установите её через pip ('pip install click'), затем импортируйте в своём Python-коде и начните описывать команды; набор сам соберёт CLI вокруг них.
Нужно ли что-то ещё, кроме интерпретатора Python?Нет. Это обычный pip-пакет без обязательных сервисов и системных зависимостей, так что подойдёт любая машина, где работает Python.
Мне нужно быть Python-разработчиком, чтобы этим пользоваться?Да, это инструмент для разработчиков, создающих CLI — от утилит с одной командой до больших программ с множеством команд; те, кто пользуется готовыми инструментами, сам Click никогда не видят.
Он будет работать на Windows и macOS или только на Linux?Везде, где работает Python. В проекте перечислены Windows, macOS и Linux, а как чисто Python-овский pip-пакет он кроссплатформенный.
Что я получу сразу из коробки при разработке с Click?Страницы справки для ваших команд генерируются автоматически, и хотя набор очень гибко настраивается, из коробки он предлагает разумные значения по умолчанию, поэтому для аккуратного CLI понадобится совсем немного кода.
У моего инструмента будет много подкоманд — Click справится с этим?Да. Он поддерживает произвольную вложенность команд и умеет подгружать подкоманды лениво, во время выполнения, поэтому большой CLI остаётся упорядоченным и быстро запускается.
Это свежий эксперимент или зрелый проект?Зрелый: разработка началась в 2014 году, а на GitHub у проекта около 17,8 тыс. звёзд. Его разрабатывает и поддерживает организация Pallets вместе с другими популярными пакетами, и она принимает пожертвования на поддержку проекта.
Почему стоит взять Click, а не писать разбор аргументов вручную?Именно для этой проблемы он и создан: его заявленная цель — сделать написание инструментов командной строки быстрым и приятным и избавить от разочарования, когда не получается реализовать задуманный CLI API.
Creator
pallets
Size
5 MB
Stars
17.8K
Age
12y
Commits · 90 Days