Garden Linux Python Library Documentation

Welcome to the Garden Linux Python Library documentation. This library provides Python tools and utilities for working with Garden Linux features, flavors, OCI artifacts, S3 buckets, and GitHub releases.

Overview

The Garden Linux Python Library is a comprehensive toolkit for managing and interacting with Garden Linux components. It includes:

• Feature Management: Parse and work with Garden Linux features and generate canonical names

• Flavor Processing: Parse flavors.yaml and generate combinations

• OCI Operations: Push OCI artifacts to registries and manage manifests

• S3 Integration: Upload and download artifacts from S3 buckets

• GitHub Integration: Create and manage GitHub releases with release notes

Quick Start

Command-Line Interface

The library provides several command-line tools for common operations. See the Command-Line Interface documentation for detailed information about all available commands.

Release Management

For information about versioning and release procedures, see the Release documentation.

API Reference

For detailed Python API documentation, including all modules, classes, and functions, see the API Reference.

Documentation Sections

Documentation:

• Command-Line Interface
  • Features Commands
    • gl-cname
    • gl-features-parse
  • Flavors Commands
    • gl-flavors-parse
  • OCI Commands
    • gl-oci
  • S3 Commands
    • gl-s3
  • GitHub Commands
    • gl-gh-release
• release documentation
  • Step by step guide
• API Reference
  • Debsrc
  • DebsrcFile
    • DebsrcFile.read()
  • GardenLinuxRepo
    • GardenLinuxRepo.get_package_version_by_name()
    • GardenLinuxRepo.get_packages_versions()
  • CName
    • CName.arch
    • CName.cname
    • CName.commit_hash
    • CName.commit_id
    • CName.feature_set
    • CName.feature_set_element
    • CName.feature_set_flag
    • CName.feature_set_list
    • CName.feature_set_platform
    • CName.features
    • CName.flavor
    • CName.load_from_release_file()
    • CName.new_from_release_file()
    • CName.platform
    • CName.platform_variant
    • CName.release_metadata_string
    • CName.save_to_release_file()
    • CName.version
    • CName.version_and_commit_id
    • CName.version_epoch
  • Parser
    • Parser.filter()
    • Parser.filter_as_dict()
    • Parser.filter_as_list()
    • Parser.filter_as_string()
    • Parser.filter_based_on_feature_set()
    • Parser.filter_graph_as_dict()
    • Parser.filter_graph_as_list()
    • Parser.filter_graph_as_string()
    • Parser.get_flavor_as_feature_set()
    • Parser.get_flavor_from_feature_set()
    • Parser.graph
    • Parser.set_default_gardenlinux_root_dir()
    • Parser.sort_graph_nodes()
    • Parser.sort_reversed_graph_nodes()
    • Parser.subset()
  • Parser
    • Parser.filter()
    • Parser.group_by_arch()
    • Parser.remove_arch()
    • Parser.should_exclude()
    • Parser.should_include_only()
  • Repository
    • Repository.checkout_repo()
    • Repository.checkout_repo_sparse()
    • Repository.commit_id
    • Repository.root
    • Repository.root_repo
  • Container
    • Container.generate_image_manifest()
    • Container.generate_index()
    • Container.generate_manifest()
    • Container.get_artifacts_metadata_from_files()
    • Container.push_index_for_tags()
    • Container.push_index_from_directory()
    • Container.push_manifest()
    • Container.push_manifest_and_artifacts()
    • Container.push_manifest_and_artifacts_from_directory()
    • Container.push_manifest_for_tags()
    • Container.read_or_generate_index()
    • Container.read_or_generate_manifest()
  • ImageManifest
    • ImageManifest.append_layer()
    • ImageManifest.arch
    • ImageManifest.cname
    • ImageManifest.feature_set
    • ImageManifest.flavor
    • ImageManifest.layers_as_dict
    • ImageManifest.version
    • ImageManifest.write_metadata_file()
  • Index
    • Index.append_manifest()
    • Index.json
    • Index.manifests_as_dict
  • Layer
    • Layer.dict
    • Layer.generate_metadata_from_file_name()
    • Layer.lookup_media_type_for_file_name()
  • Manifest
    • Manifest.commit
    • Manifest.config_from_dict()
    • Manifest.config_json
    • Manifest.digest
    • Manifest.json
    • Manifest.size
    • Manifest.version

Additional Resources

• Index - Complete index of all functions, classes, and modules

• Module Index - Index of all modules

• Search Page - Search the documentation