Major update, including better description and preview.
This commit is contained in:
parent
82ae4d1817
commit
e2da9130ba
1 changed files with 66 additions and 32 deletions
98
README.md
98
README.md
|
@ -2,56 +2,90 @@
|
|||
|
||||
## Overview
|
||||
|
||||
**OPTIMA-35** (**Organizing, Processing, Tweaking Images and Modifying scanned Analogs from 35mm Film**) is a Python-based project designed to provide a streamlined way to manage and edit metadata and images from analog photography. But can be used for any images.
|
||||
**OPTIMA-35** (**Organizing, Processing, Tweaking Images, and Modifying scanned Analogs from 35mm Film**) is a Python-based project designed to streamline the management and editing of metadata and images from analog photography. While it was created with analog photography in mind, it is versatile enough to handle any type of images.
|
||||
|
||||
This project is a *port* of my earlier work, an collection of [bash script](https://gitlab.com/sf-bashscripts/analogphotography), transitioning functionality to a more modular and maintainable design.
|
||||
This project replaces my earlier [analogphotography](https://gitlab.com/sf-bashscripts/analogphotography) bash script collection, which has now been archived in favor of OPTIMA-35.
|
||||
|
||||
**Please check** if a new branch is available and read the **changelog** to see the progress and current features of the program. The README might sometimes lag behind.
|
||||
|
||||
OPTIMA-35 is evolving! The project is transitioning from a terminal-based user interface (TUI) to a graphical user interface (GUI) using Qt (via PySide6). First TUI version was forked to [OPTIMA-35 TUI](https://gitlab.com/python_projects3802849/optima-35-tui). I intend to keep the TUI version functional since it is usefull for headless setup.
|
||||
|
||||
**GUI for OPTIMA-35 v0.3.4** with KvArcDark theme
|
||||
|
||||
*Last preview until GUI is finished.*
|
||||
**OPTIMA-35** is a cross-platform program. The **GUI** works on Linux and Windows (tested) and is expected to run on macOS. The **TUI** is currently Linux-only, as its dependency is exclusive to Linux.
|
||||
|
||||
|
||||
{width=40%}
|
||||
{width=40%}
|
||||
{width=40%}
|
||||
## **Current Status**
|
||||
**The README is temporarily outdated** while the GUI version is under development. For the latest updates, please check the **changelog**—I always maintain a detailed log of changes.
|
||||
## Current Status
|
||||
|
||||
### PLEASE NOTE
|
||||
The project is under active development. As a result:
|
||||
- The README may sometimes be outdated.
|
||||
- I encourage you to check for new branches and read the **CHANGELOG**, which is consistently updated and well-documented.
|
||||
- Bugs or unforeseen behavior may occur.
|
||||
|
||||
**OPTIMA-35** supports two modes: **GUI** and **TUI**.
|
||||
- The **GUI** is loaded by default if **PySide6** is available.
|
||||
- The **TUI** serves as a fallback when **PySide6** is unavailable or can be started explicitly using the `--tui` option with `main.py`.
|
||||
|
||||
While all features are implemented and functional, the designs of both the GUI and TUI are not yet finalized. Some safety checks are still under development.
|
||||
|
||||
|
||||
### Available Features:
|
||||
- Core features:
|
||||
- resizing
|
||||
- renaming
|
||||
- grayscale
|
||||
- Change brightness
|
||||
- Change contrast
|
||||
- Exif management
|
||||
- Add watermark
|
||||
|
||||
**Implemented Features:**
|
||||
- **Image Processing:**
|
||||
- Resizing
|
||||
- Renaming with order adjustment
|
||||
- Grayscale conversion
|
||||
- Brightness adjustment
|
||||
- Contrast adjustment
|
||||
- **EXIF Management:**
|
||||
- Copy EXIF data
|
||||
- Add custom EXIF information
|
||||
- Add GPS data
|
||||
- Add a date to EXIF
|
||||
- Remove EXIF
|
||||
- **Watermarking**
|
||||
|
||||
|
||||
### Preview GUI
|
||||
**GUI for OPTIMA-35** with KvArcDark theme on Linux
|
||||
|
||||
**Main windows**
|
||||
{width=40%}
|
||||
|
||||
**Exif tab when opened, settings disabled by default**
|
||||
{width=40%}
|
||||
|
||||
**Exif tab after enabeling own exif data**
|
||||
{width=40%}
|
||||
|
||||
**Dialog window to modify exif file without need to open yaml file**
|
||||
{width=40%}
|
||||
|
||||
### Preview TUI
|
||||
**asciinema recording for TUI**
|
||||
|
||||

|
||||
|
||||
|
||||
## Dependencies
|
||||
|
||||
To run **OPTIMA-35**, the following Python libraries are required:
|
||||
**OPTIMA-35** has two modes: **GUI** and **TUI**. Each mode has its own set of dependencies, so you don’t need to install TUI dependencies if you only plan to use the GUI (and vice versa).
|
||||
|
||||
- **pyyaml**: To handle YAML files for configuration and settings.
|
||||
- **piexif**: To read, modify, and write EXIF metadata.
|
||||
- **Pillow**: For image processing.
|
||||
- **pyside6**: GUI
|
||||
**Required Dependencies:**
|
||||
- **pyyaml**: For handling YAML files (configuration and settings).
|
||||
- **piexif**: For reading, modifying, and writing EXIF metadata.
|
||||
- **pillow**: For image processing.
|
||||
- **pyside6**: For the GUI mode.
|
||||
- **simple_term_menu**: For the TUI mode.
|
||||
|
||||
### Installing Dependencies
|
||||
|
||||
You can install the dependencies using `pip`:
|
||||
You can install the dependencies using the respective requirements file for your desired mode (**TUI** or **GUI**).
|
||||
|
||||
Using `pip`:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
pip install -r requirements_gui.txt
|
||||
```
|
||||
|
||||
Alternatively, you can use `conda` or its alternatives (`anaconda`, `mamba`, `micromamba`):
|
||||
|
||||
Alternatively, if you use **conda** or its alternatives (**anaconda**, **mamba**, **micromamba**), run:
|
||||
```bash
|
||||
conda install -c conda-forge --file requirements.txt
|
||||
conda install -c conda-forge --file requirements_gui.txt
|
||||
```
|
||||
|
||||
# Use of LLMs
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue