Metadata-Version: 2.4
Name: click-skeleton
Version: 0.32.0
Summary: Click app skeleton
Author-email: Adrien Pensart <crunchengine@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Astral Software Inc.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE-MIT
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.12
Requires-Dist: beartype>=0.20
Requires-Dist: click-aliases>=1.0.1
Requires-Dist: click-didyoumean>=0.3.0
Requires-Dist: click-help-colors>=0.9
Requires-Dist: click-option-group>=0.5.1
Requires-Dist: click>=8.1.8
Requires-Dist: dotmap>=1.3.30
Requires-Dist: requests>=2.24.0
Requires-Dist: semver>=3.0.4
Requires-Dist: types-requests>=2.32.0
Description-Content-Type: text/x-rst

==============
click-skeleton
==============
+---------------+-----------------+
|     Tools     |      Result     |
+===============+=================+
|     Coverage  |   |coverage|    |
+---------------+-----------------+

.. |coverage| image:: https://github.com/AdrienPensart/click-skeleton/blob/master/doc/coverage.svg
   :alt: Coverage badge

Description
-----------
Library to build a CLI with a well defined skeleton and helpers, including :

- completion
- real --help eagerness
- help and version colors
- readme generation
- -V / --version / version subcommand
- -h / --help / help subcommand
- subgroup creation and registering made easier

EXAMPLE CLI
-----------


Commands
--------
.. code-block::

  Usage: example-cli [OPTIONS] COMMAND [ARGS]...

    Simple CLI example

  Options:
    --global-example TEXT  A global option
    --option-one TEXT      First option
    --option-two TEXT      Second option
    -V, --version          Show the version and exit.
    -h, --help             Show this message and exit.

  Commands:
    abort                      Generates an exception
    expanded-path              Expand option path
    help                       Print help
    readme (doc)               Generates a README.rst
    subgroup (subgroup-alias)  A sub group
    version                    Print version

example-cli abort
*****************
.. code-block::

  Usage: example-cli abort [OPTIONS]

    Generates an exception on purpose (test)

  Options:
    -h, --help  Show this message and exit.

example-cli expanded-path
*************************
.. code-block::

  Usage: example-cli expanded-path [OPTIONS]

    Command with expanded path option

  Options:
    --file PATH  File path which expands
    -h, --help   Show this message and exit.

example-cli help
****************
.. code-block::

  Usage: example-cli help [OPTIONS]

    Print help

  Options:
    -h, --help  Show this message and exit.

example-cli readme
******************
.. code-block::

  Usage: example-cli readme [OPTIONS]

    Uses gen_doc click-skeleton helper to generates a complete readme

  Options:
    --output [rst|markdown]  README output format  [default: rst]
    -h, --help               Show this message and exit.

example-cli subgroup
********************
.. code-block::

  Usage: example-cli subgroup [OPTIONS] COMMAND [ARGS]...

    I am a subgroup!

  Options:
    -h, --help  Show this message and exit.

  Commands:
    help        Print help
    subcommand  A sub command

example-cli subgroup subcommand
*******************************
.. code-block::

  Usage: example-cli subgroup subcommand [OPTIONS]

    I am a subcommand!

  Options:
    --myoptions TEXT  A splitted option
    -h, --help        Show this message and exit.

example-cli version
*******************
.. code-block::

  Usage: example-cli version [OPTIONS]

    Print version, equivalent to -V and --version

  Options:
    -h, --help  Show this message and exit.
