pawnlib.docker package

from pawnlib.docker import *

Submodules

pawnlib.docker.async_docker module

from pawnlib.docker import async_docker

class AsyncDocker(client=None, filters={}, client_options={}, max_at_once=10, max_per_second=10, container_name='', count=0)

Bases: object

async close()

run_async_loop(function)

client_decorator()

pull_image(*args, **kwargs)

get_images(*args, **kwargs)

find_image(image=None)

filtering_dict(item, filters=None)

get_containers(*args, **kwargs)

parse_container_dict(container)

async delete_container(container, container_total, count)

control_container(method=None, *args, **kwargs)

async delete_container(container, container_total=0, count=0)

async list_things(args, filters={})

async rm_container(args)

async run_container(numbering, *args, **kwargs)

async run_dyn_container(config, *args, **kwargs)

extract_upper_key_to_env_list(config=None)

pawnlib.docker.compose module

from pawnlib.docker import compose

class DockerComposeBuilder(compose_file='docker-compose.yml')

Bases: object

A class to build and manage Docker Compose files interactively.

Parameters:

compose_file (optional) – Name of the Docker Compose file to be created or modified (default: “docker-compose.yml”). |default| 'docker-compose.yml'

Example

dcb = DockerComposeBuilder()

dcb.create_docker_compose()
# Starts an interactive session to create a Docker Compose file.

dcb.save_docker_compose()
# Saves the created Docker Compose data to a file.

data = dcb.get_docker_compose_data()
# Returns the Docker Compose data as a dictionary.

dcb.remove_service()
# Removes a service from the Docker Compose configuration.

create_docker_compose()

confirm_with_min_once(message, already_asked)

Set the default value to ‘yes’ at least once, and then set it to ‘no’ afterwards.

confirm_with_default(message, default=True)

Default confirm question logic

get_valid_input(message, default=None)

Get valid non-empty input from the user, validate the input.

get_ports()

Get port mappings from the user.

is_valid_port_mapping(port)

Validate port mapping format (e.g., 8080:80)

get_environment_variables()

Get environment variables from the user.

get_volumes(default_volume='./data:/data')

Get volume mappings from the user and validate the format.

is_valid_volume_mapping(volume)

Validate volume mapping format (e.g., ./data:/app/data)

validate_docker_image(image)

Validate if the Docker image exists locally or in Docker Hub

is_image_in_local(image)

Check if the Docker image exists locally using docker images command

is_image_in_docker_hub(image)

Validate if the Docker image exists in Docker Hub

add_service(service_name='', service={})

get_docker_compose_data()

Return the YAML data for Docker Compose.

remove_service()

Remove a service from the services list.

save_docker_compose()

Save the Docker Compose data to a file, with confirmation.