mlh-fellowship / click Goto Github PK

View Code? Open in Web Editor NEW

This project forked from pallets/click

0.0 2.0 2.0 3.11 MB

Python composable command line interface toolkit

Home Page: https://click.palletsprojects.com/

License: BSD 3-Clause "New" or "Revised" License

Python 99.97% Shell 0.03%

click's Introduction

$ 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:

Arbitrary nesting of commands
Automatic help page generation
Supports lazy loading of subcommands at runtime

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.

click's People

Contributors

Watchers

Forkers

leshnabalara sitevity

click's Issues

Fix #1422: Generated help with aliased group shows abbreviated command in usage

Addressing #1422

Fix #1460: hide prompt input if hide_input is enabled

I've already created a PR from my account to the main project repository. Here's the link.

I'm creating this issue so I can add it to the board as a card (let me know if I'm doing it wrong, next time I think I'll create the PR on the MLH org so that it gets added more easily to the board).

Fix #1359: Raise a more descriptive exception when @command decorator isn't called

When doing pip install -e . decorating the main CLI function with click.command instead of click.command() will cause the following error to be raised:

Traceback (most recent call last):
  File "/Users/zev/.local/share/virtualenvs/myvirtualenvname-CI6hzx9c/bin/capture", line 11, in <module>
    load_entry_point('myvirtualenvname', 'console_scripts', 'my_module_name')()
TypeError: decorator() missing 1 required positional argument: 'f'

OP asks that a more informative exception be raised that refers to the decorator not having been called.

Original issue: pallets#1359

Fix #1538: Improvement for show_default showing in case of a flag the name instead of True/False

Addressing #1538

Week 1 - Getting started

Read the contribution guide:
https://github.com/pallets/click/blob/master/CONTRIBUTING.rst

Try setting up your computer and execute the test suite locally.

Look around in the issue tracker and try finding issues for yourself.

Fix #736: Implement a prompt_required for prompt options

Original Issue

Currently the user will always be prompted for a value, even if the option itself is not required. When the user includes the flag without a value, an error is raised Error: -p option requires an argument rather than prompting for a value. This as a result also causes the other args, if any, to fail as it shifts down by 1.

Prompt only if
- flag passed as arg with no value following it
- prompt_required=True
Make it available for password_option too (issue with testing though since it prompts twice and not sure if input takes multiple values)