20 Chapter 5. obs_img_utils package
SIX
OVERVIEW
OBS Image Utilsprovides an API and CLI utilities for images in OBS.
22 Chapter 6. Overview
SEVEN
CONTRIBUTING
Contributions to OBS Image Utils are welcome and encouraged. SeeCONTRIBUTINGfor info on getting started.
24 Chapter 7. Contributing
EIGHT
ISSUES/ENHANCEMENTS
Please submit issues and requests toGithub.
26 Chapter 8. Issues/Enhancements
NINE
LICENSE
Copyright (c) 2019 SUSE LLC. All rights reserved.
Distributed under the terms of GPL-3.0+ license, seeLICENSEfor details.
28 Chapter 9. License
o
obs_img_utils,19 obs_img_utils.api,13 obs_img_utils.cli,16
obs_img_utils.exceptions,16 obs_img_utils.utils,17 obs_img_utils.web_content,19
30 Python Module Index
Symbols
__dict__ (obs_img_utils.api.OBSImageUtil attribute), 13
__dict__ (obs_img_utils.web_content.WebContent at-tribute),19
__init__()(obs_img_utils.api.OBSImageUtil method), 13
__init__()(obs_img_utils.exceptions.OBSImageUtilsException method),16
__init__() (obs_img_utils.web_content.WebContent method),19
__module__ (obs_img_utils.api.OBSImageUtil at-tribute),13
__module__(obs_img_utils.api.build_version attribute), 14
__module__(obs_img_utils.api.package_type attribute), 15
__new__() (obs_img_utils.api.package_type static method),15
__new__() (obs_img_utils.utils.img_downloader_config static method),17
__repr__() (obs_img_utils.api.build_version method), 14
__repr__() (obs_img_utils.api.package_type method), 15
__repr__()(obs_img_utils.utils.img_downloader_config method),18
__slots__ (obs_img_utils.api.build_version attribute), 14
__slots__ (obs_img_utils.api.package_type attribute), 15
__slots__ (obs_img_utils.utils.img_downloader_config attribute),18
__str__()(obs_img_utils.exceptions.OBSImageUtilsException method),16
__weakref__ (obs_img_utils.api.OBSImageUtil at-tribute),14
__weakref__(obs_img_utils.exceptions.OBSImageUtilsException attribute),16
__weakref__ (obs_img_utils.web_content.WebContent attribute),19
_asdict()(obs_img_utils.api.build_version method),14 _asdict()(obs_img_utils.api.package_type method),15 _asdict() (obs_img_utils.utils.img_downloader_config
_field_defaults (obs_img_utils.api.build_version at-tribute),14
_field_defaults (obs_img_utils.api.package_type at-tribute),15
(obs_img_utils.utils.img_downloader_config
attribute),18
_fields(obs_img_utils.api.build_version attribute),14 _fields(obs_img_utils.api.package_type attribute),15 _fields (obs_img_utils.utils.img_downloader_config
_make()(obs_img_utils.api.build_version class method), 14
_make()(obs_img_utils.api.package_type class method), 15
_make() (obs_img_utils.utils.img_downloader_config class method),18
_replace() (obs_img_utils.api.build_version method), 15
_replace() (obs_img_utils.api.package_type method), 15
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,11
--add-conditions
obs-img-utils-download command line option,9
--arch <arch>
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,12
--checksum-extension <checksum_extension>
obs-img-utils-download command line option,9
--conditions-wait-time
<conditions_wait_time>
obs-img-utils-download command line option,9
--config <config>
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,11
--debug
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,11
--disallow-licenses
obs-img-utils-download command line option,9
--disallow-packages
obs-img-utils-download command line option,9
--download-url <download_url>
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,12
--extension <extension>
obs-img-utils-download command line option,9
--filter-licenses
obs-img-utils-packages-list command line option,11
--filter-packages
obs-img-utils-packages-list command line option,11
--image-name <image_name>
obs-img-utils-download command line option,10
obs-img-utils-packages-list command
32 Index
line option,11
obs-img-utils-packages-show command line option,12
--license
obs-img-utils command line option,9 --no-color
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,11
--package-name <package_name>
obs-img-utils-packages-show command line option,11
--profile <profile>
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,12
--quiet
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,12
--target-dir <target_dir>
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,12
--verbose
obs-img-utils-download command line option,10
obs-img-utils-packages-list command line option,11
obs-img-utils-packages-show command line option,11
--version
obs-img-utils command line option,9
A
abort_if_false()(in module obs_img_utils.cli),16 add_options()(in module obs_img_utils.cli),16 arch(obs_img_utils.api.package_type property),15 arch (obs_img_utils.utils.img_downloader_config
prop-erty),18
B
build_version(class in obs_img_utils.api),14
C
checksum(obs_img_utils.api.package_type property),15
checksum_extension(obs_img_utils.utils.img_downloader_config property),18
click_progress_callback() (in module obs_img_utils.utils),17
conditions_repl()(in module obs_img_utils.utils),17 conditions_wait_time
DownloadMetadataFileExceptionOBS,16
E
echo_package()(in module obs_img_utils.utils),17 echo_packages()(in module obs_img_utils.utils),17 echo_style()(in module obs_img_utils.utils),17 extension (obs_img_utils.utils.img_downloader_config
filter_packages_by_licenses() (in module obs_img_utils.utils),17
filter_packages_by_name() (in module obs_img_utils.utils),17
G
get_checksum_from_file() (in module obs_img_utils.utils),17
get_config()(in module obs_img_utils.utils),17
get_hash_from_image() (in module
get_image() (obs_img_utils.api.OBSImageUtil method),14
get_image_packages_metadata()
(obs_img_utils.api.OBSImageUtil method), 14
get_logger()(in module obs_img_utils.utils),17
H
handle_errors()(in module obs_img_utils.utils),17
I
image_name(obs_img_utils.utils.img_downloader_config property),18
img_downloader_config(class in obs_img_utils.utils), 17
K
kiwi_version (obs_img_utils.api.build_version prop-erty),15
L
license(obs_img_utils.api.package_type property),15 license_repl()(in module obs_img_utils.utils),18 log_level(obs_img_utils.utils.img_downloader_config
property),18
M
module
obs_img_utils,19 obs_img_utils.api,13 obs_img_utils.cli,16
obs_img_utils.exceptions,16 obs_img_utils.utils,17 obs_img_utils.web_content,19
N
name(obs_img_utils.api.package_type property),15 no_color (obs_img_utils.utils.img_downloader_config
property),18
O
obs_build (obs_img_utils.api.build_version property), 15
obs-img-utils command line option --license,9
--version,9
obs-img-utils-download command line option -C,10
--add-conditions,9 --arch <arch>,10 --checksum-extension
<checksum_extension>,9 --conditions-wait-time
<conditions_wait_time>,9 --config <config>,10
--debug,10
--disallow-licenses,9 --disallow-packages,9
--download-url <download_url>,10 --extension <extension>,9
--image-name <image_name>,10 --no-color,10
--profile <profile>,10 --quiet,10
--target-dir <target_dir>,10 --verbose,10
obs-img-utils-packages-list command line option
-C,11
--arch <arch>,11 --config <config>,11 --debug,11
--download-url <download_url>,11 --filter-licenses,11
--filter-packages,11
--image-name <image_name>,11 --no-color,11
--profile <profile>,11 --quiet,11
--target-dir <target_dir>,11 --verbose,11
obs-img-utils-packages-show command line option
-C,11
--arch <arch>,12 --config <config>,11 --debug,11
--download-url <download_url>,12 --image-name <image_name>,12 --no-color,11
--package-name <package_name>,11 --profile <profile>,12
--quiet,12
--target-dir <target_dir>,12 --verbose,11
34 Index
OBSImageChecksumException,16 OBSImageConditionsException,16 OBSImageDownloadException,16
OBSImageUtil(class in obs_img_utils.api),13 OBSImageUtilsException,16
OBSImageVersionException,16
P
package_type(class in obs_img_utils.api),15 packages_repl()(in module obs_img_utils.utils),19 PackageVersionExceptionOBS,16
parse_packages_file()
(obs_img_utils.api.OBSImageUtil method), 14
parse_report_file()
(obs_img_utils.api.OBSImageUtil method), 14
print_license()(in module obs_img_utils.cli),16 process_shared_options() (in module
obs_img_utils.utils),19
profile (obs_img_utils.utils.img_downloader_config property),18
R
release(obs_img_utils.api.package_type property),15 retry()(in module obs_img_utils.utils),19
S
signature_extension
(obs_img_utils.utils.img_downloader_config property),18
style_string()(in module obs_img_utils.utils),19
T
target_dir(obs_img_utils.utils.img_downloader_config property),18
V
version(obs_img_utils.api.package_type property),15
W
wait_for_new_image()
(obs_img_utils.api.OBSImageUtil method), 14
WebContent(class in obs_img_utils.web_content),19