CodeByMrFinchum/optima35
CodeByMrFinchum/optima35
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages 1 Activity

Fixing the readme.

Browse source
This commit is contained in:
Mr Finchum 2024-12-28 11:49:24 +01:00
parent 9f7619c65a
commit 80f8bbf38c
1 changed files with 22 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -1,12 +1,15 @@
# OPTIMA-35 TUI *version*
# OPTIMA-35
## Overview
Fork from **OPTIMA-35** (**Organizing, Processing, Tweaking Images and Modifying scanned Analogs from 35mm Film**) which will preserve the TUI
**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.
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.
**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.
## **Current Status**
- While the program works and core features are available, there are currently some safety checks missing. For example, the program will write / save an image without verifying if a file with the same name already exists.
- While the program works and core features are available, there are currently no safety checks in place. For example, the program will write / save an image without verifying if a file with the same name already exists.
- Additionally, while EXIF data/metadata should be implemented correctly, there is a possibility of overlooked issues. In the worst case, a program might throw an error when handling EXIF data, though this has not occurred so far.
### Available Features:
@ -22,29 +25,38 @@ This project is a *port* of my earlier work, an collection of [bash script](http
**Gif of program in action**
![my-gif](https://gitlab.com/python_projects3802849/optima-35-tui/-/raw/main/media/v0.1.0-demo.gif?ref_type=heads)
![my-gif](https://gitlab.com/python_projects3802849/optima-35/-/raw/main/media/v0.1.0-demo.gif?ref_type=heads)
## Dependencies
To run **OPTIMA-35 TUI**, the following Python libraries are required:
To run **OPTIMA-35**, the following Python libraries are required:
- **pyyaml**: To handle YAML files for configuration and settings.
- **piexif**: To read, modify, and write EXIF metadata.
- **pillow**: For image processing.
- **Pillow**: For image processing.
- **simple\_term\_menu**: For building the initial TUI interface.
### Installing Dependencies
You can install the dependencies using `pip`:
```bash
pip install pyyaml piexif pillow simple-term-menu
pip install textual pyyaml piexif pillow simple-term-menu
```
Alternatively, you can use `conda` or its alternatives (`anaconda`, `mamba`, `micromamba`):
```bash
conda install -c conda-forge pyyaml piexif pillow simple-term-menu
conda install -c conda-forge textual pyyaml piexif pillow simple-term-menu
```
## Development Approach
Compared to my previous project, [FTL Save Manager](https://gitlab.com/python_projects3802849/ftl-save-manager), this project emphasizes:
- **Enhanced Modularity**: Classes and components are organized into separate files, making the codebase more maintainable and scalable.
- **Improved Design Principles**: Focus on creating reusable and flexible code for future expansion.
- **Slower Code Pushes**: Updates and code releases will be less frequent but of higher quality, ensuring stability and adherence to best practices.
# Use of LLMs
In the interest of transparency, I disclose that Generative AI (GAI) large language models (LLMs), including OpenAI’s ChatGPT and Ollama models (e.g., OpenCoder and Qwen2.5-coder), have been used to assist in this project.
@ -56,9 +68,8 @@ In the interest of transparency, I disclose that Generative AI (GAI) large langu
In cases where LLMs contribute directly to code or provide substantial optimizations, such contributions will be disclosed and documented in the relevant sections of the codebase.
**ollama**
- mradermacher gguf Q4K-M Instruct version of infly/OpenCoder-1.5B
- unsloth gguf Q4K_M Instruct version of both Qwen/QWEN2 1.5B and 3B
mradermacher gguf Q4K-M Instruct version of infly/OpenCoder-1.5B
unsloth gguf Q4K_M Instruct version of both Qwen/QWEN2 1.5B and 3B
### References
1. **Huang, Siming, et al.**