Split the help output into its own module.
This means I can reuse it for help output for individual subcommands.
(cherry picked from commit 0179a976ba)
This commit is contained in:
Chris Lumens
Brian C. Lane
parent
eca6a01008
commit
cd5c9385f6
@ -19,113 +19,10 @@ import sys
|
||||
import argparse
|
||||
|
||||
from composer import vernum
|
||||
from composer.cli.help import epilog
|
||||
|
||||
VERSION = "{0}-{1}".format(os.path.basename(sys.argv[0]), vernum)
|
||||
|
||||
# Documentation for the commands
|
||||
epilog = """
|
||||
compose start <BLUEPRINT> <TYPE>
|
||||
Start a compose using the selected blueprint and output type.
|
||||
|
||||
compose types
|
||||
List the supported output types.
|
||||
|
||||
compose status
|
||||
List the status of all running and finished composes.
|
||||
|
||||
compose log <UUID> [<SIZE>]
|
||||
Show the last SIZE kB of the compose log.
|
||||
|
||||
compose cancel <UUID>
|
||||
Cancel a running compose and delete any intermediate results.
|
||||
|
||||
compose delete <UUID,...>
|
||||
Delete the listed compose results.
|
||||
|
||||
compose info <UUID>
|
||||
Show detailed information on the compose.
|
||||
|
||||
compose metadata <UUID>
|
||||
Download the metadata use to create the compose to <uuid>-metadata.tar
|
||||
|
||||
compose logs <UUID>
|
||||
Download the compose logs to <uuid>-logs.tar
|
||||
|
||||
compose results <UUID>
|
||||
Download all of the compose results; metadata, logs, and image to <uuid>.tar
|
||||
|
||||
compose image <UUID>
|
||||
Download the output image from the compose. Filename depends on the type.
|
||||
|
||||
blueprints list
|
||||
List the names of the available blueprints.
|
||||
|
||||
blueprints show <BLUEPRINT,...>
|
||||
Display the blueprint in TOML format.
|
||||
|
||||
blueprints changes <BLUEPRINT,...>
|
||||
Display the changes for each blueprint.
|
||||
|
||||
blueprints diff <BLUEPRINT> <FROM-COMMIT> <TO-COMMIT>
|
||||
Display the differences between 2 versions of a blueprint.
|
||||
FROM-COMMIT can be a commit hash or NEWEST
|
||||
TO-COMMIT can be a commit hash, NEWEST, or WORKSPACE
|
||||
|
||||
blueprints save <BLUEPRINT,...>
|
||||
Save the blueprint to a file, <BLUEPRINT>.toml
|
||||
|
||||
blueprints delete <BLUEPRINT>
|
||||
Delete a blueprint from the server
|
||||
|
||||
blueprints depsolve <BLUEPRINT,...>
|
||||
Display the packages needed to install the blueprint.
|
||||
|
||||
blueprints push <BLUEPRINT>
|
||||
Push a blueprint TOML file to the server.
|
||||
|
||||
blueprints freeze <BLUEPRINT,...>
|
||||
Display the frozen blueprint's modules and packages.
|
||||
|
||||
blueprints freeze show <BLUEPRINT,...>
|
||||
Display the frozen blueprint in TOML format.
|
||||
|
||||
blueprints freeze save <BLUEPRINT,...>
|
||||
Save the frozen blueprint to a file, <blueprint-name>.frozen.toml.
|
||||
|
||||
blueprints tag <BLUEPRINT>
|
||||
Tag the most recent blueprint commit as a release.
|
||||
|
||||
blueprints undo <BLUEPRINT> <COMMIT>
|
||||
Undo changes to a blueprint by reverting to the selected commit.
|
||||
|
||||
blueprints workspace <BLUEPRINT>
|
||||
Push the blueprint TOML to the temporary workspace storage.
|
||||
|
||||
modules list
|
||||
List the available modules.
|
||||
|
||||
projects list
|
||||
List the available projects.
|
||||
|
||||
projects info <PROJECT,...>
|
||||
Show details about the listed projects.
|
||||
|
||||
sources list
|
||||
List the available sources
|
||||
|
||||
sources info <SOURCE-NAME,...>
|
||||
Details about the source.
|
||||
|
||||
sources add <SOURCE.TOML>
|
||||
Add a package source to the server.
|
||||
|
||||
sources change <SOURCE.TOML>
|
||||
Change an existing source
|
||||
|
||||
sources delete <SOURCE-NAME>
|
||||
Delete a package source.
|
||||
"""
|
||||
|
||||
def composer_cli_parser():
|
||||
""" Return the ArgumentParser for composer-cli"""
|
||||
|
||||
|
||||
129
src/composer/cli/help.py
Normal file
129
src/composer/cli/help.py
Normal file
@ -0,0 +1,129 @@
|
||||
# Copyright (C) 2018 Red Hat, Inc.
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation; either version 2 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
|
||||
# Documentation for the commands
|
||||
compose_help = """
|
||||
compose start <BLUEPRINT> <TYPE>
|
||||
Start a compose using the selected blueprint and output type.
|
||||
|
||||
compose types
|
||||
List the supported output types.
|
||||
|
||||
compose status
|
||||
List the status of all running and finished composes.
|
||||
|
||||
compose log <UUID> [<SIZE>]
|
||||
Show the last SIZE kB of the compose log.
|
||||
|
||||
compose cancel <UUID>
|
||||
Cancel a running compose and delete any intermediate results.
|
||||
|
||||
compose delete <UUID,...>
|
||||
Delete the listed compose results.
|
||||
|
||||
compose info <UUID>
|
||||
Show detailed information on the compose.
|
||||
|
||||
compose metadata <UUID>
|
||||
Download the metadata use to create the compose to <uuid>-metadata.tar
|
||||
|
||||
compose logs <UUID>
|
||||
Download the compose logs to <uuid>-logs.tar
|
||||
|
||||
compose results <UUID>
|
||||
Download all of the compose results; metadata, logs, and image to <uuid>.tar
|
||||
|
||||
compose image <UUID>
|
||||
Download the output image from the compose. Filename depends on the type.
|
||||
"""
|
||||
|
||||
blueprints_help = """
|
||||
blueprints list
|
||||
List the names of the available blueprints.
|
||||
|
||||
blueprints show <BLUEPRINT,...>
|
||||
Display the blueprint in TOML format.
|
||||
|
||||
blueprints changes <BLUEPRINT,...>
|
||||
Display the changes for each blueprint.
|
||||
|
||||
blueprints diff <BLUEPRINT> <FROM-COMMIT> <TO-COMMIT>
|
||||
Display the differences between 2 versions of a blueprint.
|
||||
FROM-COMMIT can be a commit hash or NEWEST
|
||||
TO-COMMIT can be a commit hash, NEWEST, or WORKSPACE
|
||||
|
||||
blueprints save <BLUEPRINT,...>
|
||||
Save the blueprint to a file, <BLUEPRINT>.toml
|
||||
|
||||
blueprints delete <BLUEPRINT>
|
||||
Delete a blueprint from the server
|
||||
|
||||
blueprints depsolve <BLUEPRINT,...>
|
||||
Display the packages needed to install the blueprint.
|
||||
|
||||
blueprints push <BLUEPRINT>
|
||||
Push a blueprint TOML file to the server.
|
||||
|
||||
blueprints freeze <BLUEPRINT,...>
|
||||
Display the frozen blueprint's modules and packages.
|
||||
|
||||
blueprints freeze show <BLUEPRINT,...>
|
||||
Display the frozen blueprint in TOML format.
|
||||
|
||||
blueprints freeze save <BLUEPRINT,...>
|
||||
Save the frozen blueprint to a file, <blueprint-name>.frozen.toml.
|
||||
|
||||
blueprints tag <BLUEPRINT>
|
||||
Tag the most recent blueprint commit as a release.
|
||||
|
||||
blueprints undo <BLUEPRINT> <COMMIT>
|
||||
Undo changes to a blueprint by reverting to the selected commit.
|
||||
|
||||
blueprints workspace <BLUEPRINT>
|
||||
Push the blueprint TOML to the temporary workspace storage.
|
||||
"""
|
||||
|
||||
modules_help = """
|
||||
modules list
|
||||
List the available modules.
|
||||
"""
|
||||
|
||||
projects_help = """
|
||||
projects list
|
||||
List the available projects.
|
||||
|
||||
projects info <PROJECT,...>
|
||||
Show details about the listed projects.
|
||||
"""
|
||||
|
||||
sources_help = """
|
||||
sources list
|
||||
List the available sources
|
||||
|
||||
sources info <SOURCE-NAME,...>
|
||||
Details about the source.
|
||||
|
||||
sources add <SOURCE.TOML>
|
||||
Add a package source to the server.
|
||||
|
||||
sources change <SOURCE.TOML>
|
||||
Change an existing source
|
||||
|
||||
sources delete <SOURCE-NAME>
|
||||
Delete a package source.
|
||||
"""
|
||||
|
||||
epilog = compose_help + blueprints_help + modules_help + projects_help + sources_help
|
||||
Loading…
Reference in New Issue
Block a user