Simple Caption Editor

A simple tool for managing image captions individually or in bulk. Features include systematic file renaming, text find/replace, and the ability to prepend trigger words to captions.

Simple Caption Editor is written in Python using PyQt5, only one dependency. Simple, efficient and straight to the point. This GUI was tested on both Windows and Mac.

Although still in active development, v1 delivers core functionality for caption editing and file management. Additional features and improvements are planned for future releases.

There are mature tools for generating captions, this is simply a bulk editor for manipulating these captions.

Changelog

11-09-24: Added a folder refresh option, automatic creation of empty caption files if none exist, better file name sorting, options to convert .webp and .bmp files to supported formats (.jpeg, .png) if detected in selected folder. Shoutout to an303042 for the excellent suggestions!

10-25-24: Rearranged the GUI for a better working flow, added a search captions field, added an additional keyboard shortcut to toggle between file list and editor view, unsaved changes warning, status bar in lieu of popup dialog hell and better compatibility across Windows and Mac + a couple of bug fixes.

Installation Instructions

1. Clone the repository

git clone https://github.com/rickrender/Simple-Caption-Editor/

2. Navigate to the directory

cd Simple-Caption-Editor

3. Create a virtual environment

python -m venv venv

4. Activate the virtual environment

venv\Scripts\activate  # Windows

source venv/bin/activate  # macOS

5. Install requirements

pip install -r requirements.txt

6. Run the application

python app.py

python app.py --light-mode

Updates

git pull

Quick Tips:

Customize your viewing experience using keyboard shortcuts or the menu options to adjust the font size in both the file list and editor views. This makes it easier to read and work with your captions at a comfortable size.

Save your changes to the current caption file using CTRL+S on Windows or CMD+S on macOS.

The rename structure feature helps organize your files with a consistent naming pattern. When your working directory contains multiple images with inconsistent names, simply enter a base name (like "Training") in the structure field. All images and their associated caption files will be automatically renamed following this pattern - for example, "Training_01.png" and "Training_01.txt". This is particularly useful when working with tools that require specific naming conventions or when you wish to organize your captioned images more systematically.