# sukitsubaki/nomino architecture

> Architecture diagram of the GitHub repository sukitsubaki/nomino, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sukitsubaki/nomino
- Repository: https://github.com/sukitsubaki/nomino

## Overview

##### Project Type and Its Core Purpose
- Nomino is a command-line utility tool focused on file renaming with multiple strategies. It’s not a full-stack web app but rather a utility that manipulates files based on user-selected strategies.
- The README highlights multiple renaming strategies (e.g., numbering, text addition/removal, regex, EXIF-based, restructuring, sorting) along with features like preview and undo.

##### Understand the File Structure
- The top-level directories and files include:
- LICENSE & README.md: Project documentation.
- src: The main source directory containing all code.
- Within src, key files include:
- main.py: The application’s entry point.
- cli.py: Handles menu-driven user interaction.
- file_utils.py: Manages file operations (renaming, filtering).
- log_utils.py: Manages logging of file operations and supports undo functionality.
- progress.py: Displays a progress indicator during file operations.
- exif_utils.py: Extracts EXIF data, crucial for photo renaming.
- The directory src/rename_strategies contains various modules:
- exif_rename.py, numbering.py, regex_rename.py, restructuring.py, sorting.py, strategy_handler.py, text_addition.py, text_removal.py – each implementing a different renaming strategy.

##### Main Components
- User Interface Layer: Represented by the CLI component (cli.py) which interacts directly with the user.
- Application Core:
- Main entry point (main.py) that orchestrates operations.
- Strategy Handler (strategy_handler.py) within the rename_strategies folder, which likely acts as a mediator dispatching to the appropriate renaming module.
- File Operations and Utilities:
- file_utils.py for core file handling.
- log_utils.py to record operations and manage undo functionality.
- progress.py to provide real-time feedback during operations.
- exif_utils.py specifically for handling image file metadata.
- Renaming Strategies:
- Them under a “Renaming Strategies” component, listing each strategy (e.g., numbering, regex, text addition/removal, EXIF, restructuring, sorting) as sub-components.

##### Visualizing Relationships and Data Flow
- From main.py, show connections to:
- The appropriate renaming strategy module based on user input (via the strategy handler).
- Utility modules that support file operations (file_utils.py) and logging (log_utils.py).
- Progress.py as an auxiliary component that receives updates from main.py during long-running operations.

##### Architectural Patterns
- Modularity: Each renaming strategy is implemented in isolation within its own file.
- Separation of Concerns: The CLI handles user interactions, main.py coordinates overall flow, while file operations, logging, and progress tracking are delegated to specific utility modules.
- Extendability: The strategy_handler and separate modules allow easy addition of new renaming strategies.

##### Including Relevant Technologies and Design Principles
- Use technologies/libraries as mentioned in the README (Python 3.x, and Pillow for EXIF-related functions).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    CLI["CLI (cli.py)"]:::ui

    %% Core Layer
    Core["Core (main.py)"]:::core
    StrategyHandler["Strategy Handler (strategy_handler.py)"]:::core

    %% Utility Modules
    FileOps["File Operations (file_utils.py)"]:::utils
    Logging["Logging (log_utils.py)"]:::utils
    Progress["Progress (progress.py)"]:::utils
    ExifUtils["EXIF Extraction (exif_utils.py)"]:::utils

    %% Renaming Strategies Subgraph
    subgraph "Renaming Strategies"
        EXIF["EXIF Renaming (exif_rename.py)"]:::strategy
        Numbering["Numbering (numbering.py)"]:::strategy
        Regex["Regex Renaming (regex_rename.py)"]:::strategy
        Restructuring["Restructuring (restructuring.py)"]:::strategy
        Sorting["Sorting (sorting.py)"]:::strategy
        TextAdd["Text Addition (text_addition.py)"]:::strategy
        TextRemoval["Text Removal (text_removal.py)"]:::strategy
    end

    %% Relationships
    CLI -->|"initiates"| Core
    Core -->|"dispatches"| StrategyHandler
    Core -->|"handles files"| FileOps
    Core -->|"logs actions"| Logging
    Core -->|"shows progress"| Progress
    StrategyHandler -->|"selects"| EXIF
    StrategyHandler -->|"selects"| Numbering
    StrategyHandler -->|"selects"| Regex
    StrategyHandler -->|"selects"| Restructuring
    StrategyHandler -->|"selects"| Sorting
    StrategyHandler -->|"selects"| TextAdd
    StrategyHandler -->|"selects"| TextRemoval
    EXIF -->|"uses"| ExifUtils
    Logging <-->|"feedback"| FileOps

    %% Click Events
    click CLI "https://github.com/sukitsubaki/nomino/blob/main/src/cli.py"
    click Core "https://github.com/sukitsubaki/nomino/blob/main/src/main.py"
    click StrategyHandler "https://github.com/sukitsubaki/nomino/blob/main/src/rename_strategies/strategy_handler.py"
    click FileOps "https://github.com/sukitsubaki/nomino/blob/main/src/file_utils.py"
    click Logging "https://github.com/sukitsubaki/nomino/blob/main/src/log_utils.py"
    click Progress "https://github.com/sukitsubaki/nomino/blob/main/src/progress.py"
    click ExifUtils "https://github.com/sukitsubaki/nomino/blob/main/src/exif_utils.py"
    click EXIF "https://github.com/sukitsubaki/nomino/blob/main/src/rename_strategies/exif_rename.py"
    click Numbering "https://github.com/sukitsubaki/nomino/blob/main/src/rename_strategies/numbering.py"
    click Regex "https://github.com/sukitsubaki/nomino/blob/main/src/rename_strategies/regex_rename.py"
    click Restructuring "https://github.com/sukitsubaki/nomino/blob/main/src/rename_strategies/restructuring.py"
    click Sorting "https://github.com/sukitsubaki/nomino/blob/main/src/rename_strategies/sorting.py"
    click TextAdd "https://github.com/sukitsubaki/nomino/blob/main/src/rename_strategies/text_addition.py"
    click TextRemoval "https://github.com/sukitsubaki/nomino/blob/main/src/rename_strategies/text_removal.py"

    %% Styles
    classDef ui fill:#FDEBD0,stroke:#E67E22,stroke-width:2px;
    classDef core fill:#D6EAF8,stroke:#3498DB,stroke-width:2px;
    classDef utils fill:#D5F5E3,stroke:#28B463,stroke-width:2px;
    classDef strategy fill:#FADBD8,stroke:#E74C3C,stroke-width:2px;
```
