docker-analyzer 0.1.0

A lightweight to tool to analyse and compare Docker images instantly, focusing on layer analysis

Docker Analyzer CLI

Finally a lightweight tool to inspect and compare Docker images instantly, focusing on layer analysis.

Overview

Docker Analyzer CLI is a Python-based command-line interface designed to analyze and compare Docker images. It provides quick insights into image layers, size optimizations, and differences, making it an essential tool for developers and DevOps engineers.

Features

• Layer Analysis: Inspect Docker image layers to identify redundancies or inefficiencies.
• Image Comparison: Compare two images to find shared, duplicated, or non-shared layers.
• CLI Interface: A powerful and flexible command-line interface.
• Web GUI Integration: Optionally launch a web-based interface for interactive analysis.
• Custom Configuration: Configure temporary directories, logging, and output formats.

Installation

1. Clone the repository:

   git clone https://github.com/gianfa/docker_analyzer.git
   

2. Navigate to the project directory:

   cd docker-inspector
   

3. Install the tool using Poetry:

   poetry install
   

   For global CLI availability:

   poetry build
   pip install dist/docker_analyzer-*.whl
   

CLI Usage

Getting Help

To view all available commands and options:

docker_analyzer --help

Common Commands

Get Temporary Directory

Displays the temporary directory used for file storage:

docker_analyzer get-temp-dir

List Docker Images

Lists all Docker images available on the system:

docker_analyzer list-images

Launch Web GUI

Starts the web-based graphical interface:

docker_analyzer web-gui

Navigate to http://localhost:5002 in your browser to use the GUI.

Comparison Examples

Compare Shared Layers

Identify layers that are shared between two images:

docker_analyzer compare shared-layers python:3.9-slim python:3.9

Compare Duplicated Layers

Find duplicated layers within an image or across two images:

docker_analyzer compare duplicated-layers python:3.9-slim python:3.9

Compare Non-Shared Layers

Identify layers unique to each image:

docker_analyzer compare non-shared-layers python:3.9-slim python:3.9

Compare Total Sizes

Compare the total sizes of two images:

docker_analyzer compare total-sizes python:3.9-slim python:3.9

Development

Running Tests

Run all tests using pytest:

poetry run pytest

Code Style

The project adheres to PEP 8. Check code formatting using black:

poetry run black .

Contributing

We welcome contributions! To contribute:

1. Fork the repository.
2. Create a feature branch.
3. Submit a pull request with a detailed description.

License

This project is licensed under the MIT License. See the LICENSE file for details.