diff --git a/docs/composer.cli.rst b/docs/composer.cli.rst index 81a5776f..50ff52f2 100644 --- a/docs/composer.cli.rst +++ b/docs/composer.cli.rst @@ -8,79 +8,79 @@ composer.cli.blueprints module ------------------------------ .. automodule:: composer.cli.blueprints - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: composer.cli.cmdline module --------------------------- .. automodule:: composer.cli.cmdline - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: composer.cli.compose module --------------------------- .. automodule:: composer.cli.compose - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: composer.cli.help module ------------------------ .. automodule:: composer.cli.help - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: composer.cli.modules module --------------------------- .. automodule:: composer.cli.modules - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: composer.cli.projects module ---------------------------- .. automodule:: composer.cli.projects - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: composer.cli.sources module --------------------------- .. automodule:: composer.cli.sources - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: composer.cli.status module -------------------------- .. automodule:: composer.cli.status - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: composer.cli.utilities module ----------------------------- .. automodule:: composer.cli.utilities - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: composer.cli - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/composer.rst b/docs/composer.rst index 5314fc0c..dd0c06cb 100644 --- a/docs/composer.rst +++ b/docs/composer.rst @@ -6,7 +6,7 @@ Subpackages .. toctree:: - composer.cli + composer.cli Submodules ---------- @@ -15,23 +15,23 @@ composer.http\_client module ---------------------------- .. automodule:: composer.http_client - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: composer.unix\_socket module ---------------------------- .. automodule:: composer.unix_socket - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: Module contents --------------- .. automodule:: composer - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo index b48190b2..54cfc865 100644 --- a/docs/html/.buildinfo +++ b/docs/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 98a432c0452272f3968f9d4d9720ed79 +config: f8c32864d71075ed86014ee145636981 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/html/.doctrees/environment.pickle b/docs/html/.doctrees/environment.pickle index c6c1215c..6092882e 100644 Binary files a/docs/html/.doctrees/environment.pickle and b/docs/html/.doctrees/environment.pickle differ diff --git a/docs/html/.doctrees/livemedia-creator.doctree b/docs/html/.doctrees/livemedia-creator.doctree index f52af600..7397f304 100644 Binary files a/docs/html/.doctrees/livemedia-creator.doctree and b/docs/html/.doctrees/livemedia-creator.doctree differ diff --git a/docs/html/.doctrees/lorax-composer.doctree b/docs/html/.doctrees/lorax-composer.doctree index cc0c7cfd..1bc583c8 100644 Binary files a/docs/html/.doctrees/lorax-composer.doctree and b/docs/html/.doctrees/lorax-composer.doctree differ diff --git a/docs/html/.doctrees/pylorax.api.doctree b/docs/html/.doctrees/pylorax.api.doctree index 291dc23b..0c572ee6 100644 Binary files a/docs/html/.doctrees/pylorax.api.doctree and b/docs/html/.doctrees/pylorax.api.doctree differ diff --git a/docs/html/.doctrees/pylorax.doctree b/docs/html/.doctrees/pylorax.doctree index 05396f41..9ba391ac 100644 Binary files a/docs/html/.doctrees/pylorax.doctree and b/docs/html/.doctrees/pylorax.doctree differ diff --git a/docs/html/_modules/composer/cli.html b/docs/html/_modules/composer/cli.html index 5ddfa492..142bc38f 100644 --- a/docs/html/_modules/composer/cli.html +++ b/docs/html/_modules/composer/cli.html @@ -8,7 +8,7 @@ -
composer.cli.blueprints.
blueprints_changes
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_changes
(socket_path, api_version, args, show_json=False)[source]¶
Display the changes for each of the blueprints
composer.cli.blueprints.
blueprints_cmd
(opts)[source]¶composer.cli.blueprints.
blueprints_cmd
(opts)[source]¶
Process blueprints commands
composer.cli.blueprints.
blueprints_delete
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_delete
(socket_path, api_version, args, show_json=False)[source]¶
Delete a blueprint from the server
composer.cli.blueprints.
blueprints_depsolve
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_depsolve
(socket_path, api_version, args, show_json=False)[source]¶
Display the packages needed to install the blueprint
composer.cli.blueprints.
blueprints_diff
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_diff
(socket_path, api_version, args, show_json=False)[source]¶
Display the differences between 2 versions of a blueprint
composer.cli.blueprints.
blueprints_freeze
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_freeze
(socket_path, api_version, args, show_json=False)[source]¶
Handle the blueprints freeze commands
composer.cli.blueprints.
blueprints_freeze_save
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_freeze_save
(socket_path, api_version, args, show_json=False)[source]¶
Save the frozen blueprint to a TOML file
composer.cli.blueprints.
blueprints_freeze_show
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_freeze_show
(socket_path, api_version, args, show_json=False)[source]¶
Show the frozen blueprint in TOML format
composer.cli.blueprints.
blueprints_list
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_list
(socket_path, api_version, args, show_json=False)[source]¶
Output the list of available blueprints
composer.cli.blueprints.
blueprints_push
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_push
(socket_path, api_version, args, show_json=False)[source]¶
Push a blueprint TOML file to the server, updating the blueprint
composer.cli.blueprints.
blueprints_save
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_save
(socket_path, api_version, args, show_json=False)[source]¶
Save the blueprint to a TOML file
composer.cli.blueprints.
blueprints_show
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_show
(socket_path, api_version, args, show_json=False)[source]¶
Show the blueprints, in TOML format
composer.cli.blueprints.
blueprints_tag
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_tag
(socket_path, api_version, args, show_json=False)[source]¶
Tag the most recent blueprint commit as a release
composer.cli.blueprints.
blueprints_undo
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_undo
(socket_path, api_version, args, show_json=False)[source]¶
Undo changes to a blueprint
composer.cli.blueprints.
blueprints_workspace
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.blueprints.
blueprints_workspace
(socket_path, api_version, args, show_json=False)[source]¶
Push the blueprint TOML to the temporary workspace storage
composer.cli.blueprints.
dict_names
(lst)[source]¶composer.cli.blueprints.
dict_names
(lst)[source]¶
Return comma-separated list of the dict's name/user fields
composer.cli.blueprints.
prettyCommitDetails
(change, indent=4)[source]¶composer.cli.blueprints.
prettyCommitDetails
(change, indent=4)[source]¶
Print the blueprint's change in a nice way
composer.cli.blueprints.
pretty_dict
(d)[source]¶composer.cli.blueprints.
pretty_dict
(d)[source]¶
Return the dict as a human readable single line
composer.cli.blueprints.
pretty_diff_entry
(diff)[source]¶composer.cli.blueprints.
pretty_diff_entry
(diff)[source]¶
Generate nice diff entry string.
composer.cli.cmdline.
composer_cli_parser
()[source]¶composer.cli.cmdline.
composer_cli_parser
()[source]¶
Return the ArgumentParser for composer-cli
composer.cli.compose.
compose_cancel
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_cancel
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Cancel a running compose
composer.cli.compose.
compose_cmd
(opts)[source]¶composer.cli.compose.
compose_cmd
(opts)[source]¶
Process compose commands
composer.cli.compose.
compose_delete
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_delete
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Delete a finished compose's results
composer.cli.compose.
compose_image
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_image
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Download the compose's output image
composer.cli.compose.
compose_info
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_info
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Return detailed information about the compose
composer.cli.compose.
compose_list
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_list
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Return a simple list of compose identifiers
composer.cli.compose.
compose_log
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_log
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Show the last part of the compose log
composer.cli.compose.
compose_logs
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_logs
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Download a tar of the compose's logs
composer.cli.compose.
compose_metadata
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_metadata
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Download a tar file of the compose's metadata
composer.cli.compose.
compose_results
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_results
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Download a tar file of the compose's results
composer.cli.compose.
compose_start
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_start
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Start a new compose using the selected blueprint and type
composer.cli.compose.
compose_status
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_status
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Return the status of all known composes
composer.cli.compose.
compose_types
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶composer.cli.compose.
compose_types
(socket_path, api_version, args, show_json=False, testmode=0)[source]¶
Return information about the supported compose types
composer.cli.modules.
modules_cmd
(opts)[source]¶composer.cli.modules.
modules_cmd
(opts)[source]¶
Process modules commands
composer.cli.projects.
projects_cmd
(opts)[source]¶composer.cli.projects.
projects_cmd
(opts)[source]¶
Process projects commands
composer.cli.projects.
projects_info
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.projects.
projects_info
(socket_path, api_version, args, show_json=False)[source]¶
Output info on a list of projects
composer.cli.projects.
projects_list
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.projects.
projects_list
(socket_path, api_version, args, show_json=False)[source]¶
Output the list of available projects
composer.cli.sources.
sources_add
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.sources.
sources_add
(socket_path, api_version, args, show_json=False)[source]¶
Add or change a source
composer.cli.sources.
sources_cmd
(opts)[source]¶composer.cli.sources.
sources_cmd
(opts)[source]¶
Process sources commands
composer.cli.sources.
sources_delete
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.sources.
sources_delete
(socket_path, api_version, args, show_json=False)[source]¶
Delete a source
composer.cli.sources.
sources_info
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.sources.
sources_info
(socket_path, api_version, args, show_json=False)[source]¶
Output info on a list of projects
composer.cli.sources.
sources_list
(socket_path, api_version, args, show_json=False)[source]¶composer.cli.sources.
sources_list
(socket_path, api_version, args, show_json=False)[source]¶
Output the list of available sources
composer.cli.status.
status_cmd
(opts)[source]¶composer.cli.status.
status_cmd
(opts)[source]¶
Process status commands
composer.cli.utilities.
argify
(args)[source]¶composer.cli.utilities.
argify
(args)[source]¶
Take a list of human args and return a list with each item
composer.cli.utilities.
frozen_toml_filename
(blueprint_name)[source]¶composer.cli.utilities.
frozen_toml_filename
(blueprint_name)[source]¶
Convert a blueprint name into a filename.toml
composer.cli.utilities.
handle_api_result
(result, show_json=False)[source]¶composer.cli.utilities.
handle_api_result
(result, show_json=False)[source]¶
Log any errors, return the correct value
composer.cli.utilities.
packageNEVRA
(pkg)[source]¶composer.cli.utilities.
packageNEVRA
(pkg)[source]¶
Return the package info as a NEVRA
composer.cli.utilities.
toml_filename
(blueprint_name)[source]¶composer.cli.utilities.
toml_filename
(blueprint_name)[source]¶
Convert a blueprint name into a filename.toml
composer.cli.
main
(opts)[source]¶composer.cli.
main
(opts)[source]¶
Main program execution
composer.http_client.
api_url
(api_version, url)[source]¶composer.http_client.
api_url
(api_version, url)[source]¶
Return the versioned path to the API route
composer.http_client.
append_query
(url, query)[source]¶composer.http_client.
append_query
(url, query)[source]¶
Add a query argument to a URL
The query should be of the form "param1=what¶m2=ever", i.e., no leading '?'. The new query data will be appended to any existing @@ -246,7 +246,7 @@ query string.
composer.http_client.
delete_url_json
(socket_path, url)[source]¶composer.http_client.
delete_url_json
(socket_path, url)[source]¶
Send a DELETE request to the url and return JSON response
composer.http_client.
download_file
(socket_path, url, progress=True)[source]¶composer.http_client.
download_file
(socket_path, url, progress=True)[source]¶
Download a file, saving it to the CWD with the included filename
composer.http_client.
get_filename
(headers)[source]¶composer.http_client.
get_filename
(headers)[source]¶
Get the filename from the response header
composer.http_client.
get_url_json
(socket_path, url)[source]¶composer.http_client.
get_url_json
(socket_path, url)[source]¶
Return the JSON results of a GET request
composer.http_client.
get_url_json_unlimited
(socket_path, url, total_fn=None)[source]¶composer.http_client.
get_url_json_unlimited
(socket_path, url, total_fn=None)[source]¶
Return the JSON results of a GET request
For URLs that use offset/limit arguments, this command will fetch all results for the given request.
@@ -342,7 +342,7 @@ fetch all results for the given request.composer.http_client.
get_url_raw
(socket_path, url)[source]¶composer.http_client.
get_url_raw
(socket_path, url)[source]¶
Return the raw results of a GET request
composer.http_client.
post_url
(socket_path, url, body)[source]¶composer.http_client.
post_url
(socket_path, url, body)[source]¶
POST raw data to the URL
composer.http_client.
post_url_json
(socket_path, url, body)[source]¶composer.http_client.
post_url_json
(socket_path, url, body)[source]¶
POST some JSON data to the URL
composer.http_client.
post_url_toml
(socket_path, url, body)[source]¶composer.http_client.
post_url_toml
(socket_path, url, body)[source]¶
POST a TOML string to the URL
composer.unix_socket.
UnixHTTPConnection
(socket_path, timeout=60)[source]¶composer.unix_socket.
UnixHTTPConnection
(socket_path, timeout=60)[source]¶
Bases: http.client.HTTPConnection
, object
connect
()[source]¶connect
()[source]¶
Connect to the host and port specified in __init__.
composer.unix_socket.
UnixHTTPConnectionPool
(socket_path, timeout=60)[source]¶composer.unix_socket.
UnixHTTPConnectionPool
(socket_path, timeout=60)[source]¶
Bases: urllib3.connectionpool.HTTPConnectionPool
P
|