forgot main file ...

docker_clean.py

@@ -0,0 +1,133 @@
+#!/usr/bin/env python
+# coding: utf-8
+"""
+Docker Clean command.
+
+Clean unused containers, images, volumes and networks.
+That saves a lot of space ...
+"""
+
+import sys
+import click
+import humanfriendly
+from docker import client
+DOCKER_CLIENT = client.from_env(timeout=360)
+
+
+@click.command(help="""Clean Docker containers, images, volumes and networks
+that are not in use""", name="docker-clean")
+@click.version_option('1.0.1')
+@click.option('--force', '-f', help="Do it", is_flag=True)
+@click.option('--containers/--no-containers', '-c/', help="Remove containers", is_flag=True, default=True)
+@click.option('--images/--no-images', '-i/', help="Remove images", is_flag=True, default=True)
+@click.option('--volumes/--no-volumes', '-V/', help="Remove volumes", is_flag=True, default=True)
+@click.option('--networks/--no-networks', '-n/', help="Remove networks", is_flag=True, default=True)
+def clean(
+        force: bool = False,
+        containers: bool = True,
+        images: bool = True,
+        volumes: bool = True,
+        networks: bool = True):
+    """See command help."""
+
+    if containers is True:
+        click.secho('Cleaning Docker stopped containers:', fg='green')
+        remove_containers(force)
+    if images is True:
+        click.secho('Cleaning Docker unused images:', fg='green')
+        remove_images(force)
+    if volumes is True:
+        click.secho('Cleaning Docker unused volumes:', fg='green')
+        remove_volumes(force)
+    if networks is True:
+        click.secho('Cleaning Docker unused networks:', fg='green')
+        remove_networks(force)
+
+
+def remove_containers(force: bool):
+    """Remove exited containers."""
+    stopped_containers = DOCKER_CLIENT.containers.list(filters={'status': 'exited'})
+    if not stopped_containers:
+        print('  No exited container to remove')
+        return
+
+    if force is False:
+        click.secho("  --force is not set so I won't do anything", fg='red')
+        return
+
+    res = DOCKER_CLIENT.containers.prune()
+    cts = len(res['ContainersDeleted'])
+    space = humanfriendly.format_size(res['SpaceReclaimed'])
+    click.echo('  Removed {} exited container(s), saved {}'.format(cts, space))
+
+
+def remove_images(force: bool):
+    """Remove unused images."""
+    if force is False:
+        click.secho("  --force is not set so I won't do anything", fg='red')
+        return
+
+    res = DOCKER_CLIENT.images.prune(filters={'dangling': False})
+    if res['ImagesDeleted'] is None:
+        print('  No image to remove')
+        return
+
+    images = len(res['ImagesDeleted'])
+    space = humanfriendly.format_size(res['SpaceReclaimed'])
+    click.echo('  Removed {} images(s), saved {}'.format(images, space))
+
+
+def remove_networks(force: bool):
+    """Remove unused networks."""
+    if force is False:
+        click.secho("  --force is not set so I won't do anything", fg='red')
+        return
+
+    res = DOCKER_CLIENT.networks.prune()
+    if res['NetworksDeleted'] is None:
+        print('  No network to remove')
+        return
+
+    networks = len(res['NetworksDeleted'])
+    click.echo('  Removed {} network(s)'.format(networks))
+
+
+def remove_volumes(force: bool):
+    """Remove unused volumes."""
+    if force is False:
+        click.secho("  --force is not set so I won't do anything", fg='red')
+        return
+
+    res = DOCKER_CLIENT.volumes.prune()
+    if (res['VolumesDeleted'] is None) or (not res['VolumesDeleted']):
+        print('  No volume to remove')
+        return
+
+    volumes = len(res['VolumesDeleted'])
+    space = humanfriendly.format_size(res['SpaceReclaimed'])
+    click.echo('  Removed {} volume(s), saved {}'.format(volumes, space))
+
+
+def main():
+    """Generate the CLI."""
+    try:
+        clean()
+    except Exception as error:
+        msg = click.style(r""" ______ _____  _____   ____  _____
+|  ____|  __ \|  __ \ / __ \|  __ \
+| |__  | |__) | |__) | |  | | |__) |
+|  __| |  _  /|  _  /| |  | |  _  /
+| |____| | \ \| | \ \| |__| | | \ \
+|______|_|  \_\_|  \_\\____/|_|  \_\
+
+""", fg='yellow')
+        msg += click.style('{}'.format(error), fg='red')
+
+        click.echo(msg)
+        click.echo()
+        # raise error
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()