diff options
| author | David Lord <davidism@gmail.com> | 2018-08-28 07:45:21 -0700 |
|---|---|---|
| committer | David Lord <davidism@gmail.com> | 2018-08-28 07:46:24 -0700 |
| commit | dff4fb4bfd7ec8472d368549d3d819523565911a (patch) | |
| tree | 4dad0554de35d13fbe16ab62e026ab3a19951c81 /README.rst | |
| parent | 8df9a6b2847b23de5c65dcb16f715a7691c60743 (diff) | |
| download | click-dff4fb4bfd7ec8472d368549d3d819523565911a.tar.gz | |
use pallets-sphinx-themes
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 44 |
1 files changed, 22 insertions, 22 deletions
@@ -1,22 +1,20 @@ \$ click\_ ========== -What's 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. +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 + +- arbitrary nesting of commands +- automatic help page generation +- supports lazy loading of subcommands at runtime Installing @@ -28,7 +26,10 @@ Install and update using `pip`_: $ pip install click -Click supports Python 3.4 and newer, Python 2.7, and PyPy +Click supports Python 3.4 and newer, Python 2.7, and PyPy. + +.. _pip: https://pip.pypa.io/en/stable/quickstart/ + A Simple Example ---------------- @@ -61,6 +62,7 @@ And what it looks like when run: Hello John! Hello John! + Donate ------ @@ -69,23 +71,21 @@ it uses. 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://psfmember.org/civicrm/contribute/transact?reset=1&id=20 +.. _please donate today: https://palletsprojects.com/donate Links ----- -* Website: https://www.palletsprojects.com/p/click/ -* Documentation: http://click.pocoo.org/ -* License: `BSD <https://github.com/pallets/click/blob/master/LICENSE>`_ -* Releases: https://pypi.org/project/click/ -* Code: https://github.com/pallets/click -* Issue tracker: https://github.com/pallets/click/issues -* Test status: +* Website: https://palletsprojects.com/p/click/ +* Documentation: https://click.palletsprojects.com/ +* License: `BSD <https://github.com/pallets/click/blob/master/LICENSE>`_ +* Releases: https://pypi.org/project/click/ +* Code: https://github.com/pallets/click +* Issue tracker: https://github.com/pallets/click/issues +* Test status: - * Linux, Mac: https://travis-ci.org/pallets/click - * Windows: https://ci.appveyor.com/project/pallets/click + * Linux, Mac: https://travis-ci.org/pallets/click + * Windows: https://ci.appveyor.com/project/pallets/click -* Test coverage: https://codecov.io/gh/pallets/click - -.. _pip: https://pip.pypa.io/en/stable/quickstart/ +* Test coverage: https://codecov.io/gh/pallets/click |