You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
David Prévot a480a6e243
Update changelog for 8.1.3-2~bpo11+1~evo release
3 weeks ago
.github New upstream version 8.1.3 4 months ago
artwork Imported Upstream version 6.6 7 years ago
debian Update changelog for 8.1.3-2~bpo11+1~evo release 3 weeks ago
docs New upstream version 8.1.3 4 months ago
examples New upstream version 8.1.3 4 months ago
requirements New upstream version 8.1.3 4 months ago
src/click New upstream version 8.1.3 4 months ago
tests New upstream version 8.1.3 4 months ago
.editorconfig New upstream version 8.0.2 1 year ago
.gitignore New upstream version 8.1.3 4 months ago
.pre-commit-config.yaml New upstream version 8.1.3 4 months ago
.readthedocs.yaml New upstream version 8.1.3 4 months ago
CHANGES.rst New upstream version 8.1.3 4 months ago
CODE_OF_CONDUCT.md New upstream version 8.0.2 1 year ago
CONTRIBUTING.rst New upstream version 8.0.2 1 year ago
LICENSE.rst New upstream version 7.1.2 3 years ago
MANIFEST.in New upstream version 8.0.2 1 year ago
README.rst New upstream version 8.0.2 1 year ago
setup.cfg New upstream version 8.1.3 4 months ago
setup.py New upstream version 8.0.2 1 year ago
tox.ini New upstream version 8.1.3 4 months ago

README.rst

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


Installing
----------

Install and update using `pip`_:

.. code-block:: text

    $ pip install -U click

.. _pip: https://pip.pypa.io/en/stable/getting-started/


A Simple Example
----------------

.. code-block:: python

    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()

.. code-block:: text

    $ 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`_.

.. _please donate today: https://palletsprojects.com/donate


Links
-----

-   Documentation: https://click.palletsprojects.com/
-   Changes: https://click.palletsprojects.com/changes/
-   PyPI Releases: https://pypi.org/project/click/
-   Source Code: https://github.com/pallets/click
-   Issue Tracker: https://github.com/pallets/click/issues
-   Website: https://palletsprojects.com/p/click
-   Twitter: https://twitter.com/PalletsTeam
-   Chat: https://discord.gg/pallets