Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make examples section nicer. #2580

Open
wants to merge 2 commits into
base: 8.1.x
Choose a base branch
from
Open

Make examples section nicer. #2580

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
26662e9
Make examples section nicer.
Rowlando13 Aug 7, 2023
483e57f
Fix spelling and remove old links.
Rowlando13 Aug 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 12 additions & 29 deletions docs/quickstart.rst
View file
Open in desktop
Expand Up @@ -64,37 +64,20 @@ virtualenv::

A few seconds later and you are good to go.

Screencast and Examples
Examples
-----------------------

There is a screencast available which shows the basic API of Click and
how to build simple applications with it. It also explores how to build
commands with subcommands.

* `Building Command Line Applications with Click
<https://www.youtube.com/watch?v=kNke39OZ2k0>`_

Examples of Click applications can be found in the documentation as well
as in the GitHub repository together with readme files:

* ``inout``: `File input and output
<https://github.com/pallets/click/tree/main/examples/inout>`_
* ``naval``: `Port of docopt naval example
<https://github.com/pallets/click/tree/main/examples/naval>`_
* ``aliases``: `Command alias example
<https://github.com/pallets/click/tree/main/examples/aliases>`_
* ``repo``: `Git-/Mercurial-like command line interface
<https://github.com/pallets/click/tree/main/examples/repo>`_
* ``complex``: `Complex example with plugin loading
<https://github.com/pallets/click/tree/main/examples/complex>`_
* ``validation``: `Custom parameter validation example
<https://github.com/pallets/click/tree/main/examples/validation>`_
* ``colors``: `Color support demo
<https://github.com/pallets/click/tree/main/examples/colors>`_
* ``termui``: `Terminal UI functions demo
<https://github.com/pallets/click/tree/main/examples/termui>`_
* ``imagepipe``: `Multi command chaining demo
<https://github.com/pallets/click/tree/main/examples/imagepipe>`_
Some standalone examples of Click applications are packaged with Click. They are available in the `examples folder <https://github.com/pallets/click/tree/main/examples>`_ of the repo.

* `inout <https://github.com/pallets/click/tree/main/examples/inout>`_ : A very simple example of an application that can read from files and write to files and also accept input from stdin or write to stdout.
* `validation <https://github.com/pallets/click/tree/main/examples/validation>`_ : A simple example of an application that performs custom validation of parameters in different ways.
* `naval <https://github.com/pallets/click/tree/main/examples/naval>`_ : Port of the `docopt <http://docopt.org/>`_ naval example.
* `colors <https://github.com/pallets/click/tree/main/examples/colors>`_ : A simple example that colorizes text. Uses colorama on Windows.
* `aliases <https://github.com/pallets/click/tree/main/examples/aliases>`_ : An advanced example that implements :ref:`aliases`.
* `imagepipe <https://github.com/pallets/click/tree/main/examples/imagepipe>`_ : A complex example that implements some :ref:`multi-command-chaining` . It chains together image processing instructions. Requires pillow.
* `repo <https://github.com/pallets/click/tree/main/examples/repo>`_ : An advanced example that implements a Git-/Mercurial-like command line interface.
* `complex <https://github.com/pallets/click/tree/main/examples/complex>`_ : A very advanced example that implements loading subcommands dynamically from a plugin folder.
* `termui <https://github.com/pallets/click/tree/main/examples/termui>`_ : A simple example that showcases terminal UI helpers provided by click.

Basic Concepts - Creating a Command
-----------------------------------
Expand Down