Duskfallcrew commited on
Commit
ec83692
·
verified ·
1 Parent(s): d18840c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +288 -85
README.md CHANGED
@@ -8,147 +8,350 @@ tags:
8
  - organization
9
  pretty_name: Dataset Tools
10
  ---
 
11
 
12
- # Dataset-Tools: A Simple Dataset Viewer for AI Art
13
 
14
- <span style="text-align: center">
15
 
16
- [__How to use Dataset-Tools__](#how-to-use-dataset-tools)<br>
17
- [__Launching the Application__](#launching-the-application)<br>
18
- [__User Interface Overview__](#user-interface-overview)<br>
19
- [__Improve the Project__](CONTRIBUTING.md)<br>
20
- [__Help the Creators__](#help-the-creators)<br>
21
 
22
- </span>
23
 
24
- | Badge | Description |
25
- | :-------------------------------------- | :---------------------------------------- |
26
- | [![GitHub](https://img.shields.io/badge/GitHub-View%20on%20GitHub-181717?logo=github&style=for-the-badge)](https://github.com/Ktiseos-Nyx) | Our Github |
27
- | ![Build Status](https://img.shields.io/badge/build-passing-brightgreen) | Indicates the build status of the project. |
28
- | [![PyTest](https://github.com/Ktiseos-Nyx/Dataset-Tools/actions/workflows/pytest.yml/badge.svg)](https://github.com/Ktiseos-Nyx/Dataset-Tools/actions/workflows/pytest.yml) | PyTest results. |
29
- | ![CC0 1.0 License](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg) | Creative Commons Zero v1.0 Universal (Public Domain Dedication) |
30
- | [![Discord](https://img.shields.io/discord/1024442483750490222?logo=discord&style=for-the-badge&color=5865F2)](https://discord.gg/5t2kYxt7An) | Discord Server |
31
- | [![Ko-Fi](https://img.shields.io/badge/Ko--fi-Support%20on%20Ko--fi-FF5E5B?logo=kofi&style=for-the-badge)](https://ko-fi.com/duskfallcrew) | Duskfallcrew Ko-FI |
32
- | [![Twitch](https://img.shields.io/badge/Twitch-Follow%20on%20Twitch-9146FF?logo=twitch&style=for-the-badge)](https://twitch.tv/duskfallcrew) | Watch on Twitch |
33
 
 
 
34
 
 
35
 
 
36
 
 
37
 
38
  <hr>
39
 
40
- Dataset-Tools is a desktop application designed to help users browse and manage their image and text datasets, particularly those used with AI art generation tools like Stable Diffusion. Developed using PyQt6, it provides a simple and intuitive graphical interface for browsing images, viewing metadata, and examining associated text prompts. This project is inspired by tools within the AI art community (☮️[receyuki](https://github.com/receyuki/stable-diffusion-prompt-reader)🤍) and aims to empower users in improving their dataset curation workflow.
41
 
42
- https://github.com/user-attachments/assets/f8b4187b-2603-4bae-aa4a-dc3f621b5696
43
 
 
44
 
45
- ## How to Use Dataset-Tools
 
 
 
 
 
 
 
 
 
 
 
46
 
47
- ### Requirements
48
 
49
- To run the program, you will need the following software:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
 
51
- #### Python:
52
- - [Python.org](https://www.python.org/downloads/) or [Try `uv`](https://github.com/astral-sh/uv?tab=readme-ov-file#installation)
53
 
54
- #### Git:
55
- - [Windows](https://gitforwindows.org/)
56
- - [MacOS first option](https://git-scm.com/downloads/mac), [or second option](https://brew.sh/)
57
- - [Linux](https://git-scm.com/downloads/linux)
58
 
59
- ### Launching the Application
60
 
61
- #### 1. Open your ``terminal`` shell console of choice.🐣 (ie: ```powershell```,```cmd```,```zsh```,```bash```, etc.)
62
 
63
- #### 2. ``git clone`` or download the Dataset-Tools repository from GitHub.
64
 
65
- ```sh
66
  git clone https://github.com/Ktiseos-Nyx/Dataset-Tools.git
 
 
 
67
  ```
68
 
69
- #### 3. Move into Dataset-Tools folder and `pip install`the required dependencies:
70
 
71
- ```sh
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
72
  cd Dataset-Tools
73
- pip install .
74
  ```
75
 
76
- > [!NOTE]
77
- > `uv` users
78
- > ```sh
79
- > cd Dataset-Tools
80
- > uv pip install .
81
- > ```
82
 
83
- #### 4. Run the application with `dataset-tools` command:
84
 
85
- ```sh
86
- dataset-tools
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
87
  ```
88
 
89
- #### You're in!
90
 
91
- <br>
 
 
92
 
93
- ### User Interface Overview
94
- <hr>
95
 
96
- The application window has the following main components:
 
 
97
 
98
- * **Current Folder:** Displays the path of the currently loaded folder.
99
- * **Open Folder:** A button to select a folder containing images and text files.
100
- * **Image List:** Displays a list of images and text files found in the selected folder.
101
- * **Image Preview:** An area to display a selected image.
102
- * **Metadata Box:** A text area to display the extracted metadata from the selected image (including Stable Diffusion prompt, settings, etc.).
 
 
 
 
 
 
 
103
 
104
- ### Managing Images and Text
105
 
106
- * **Selecting Images:** Click on an image or text file in the list to display its preview, metadata, and associated text content.
107
- * **Viewing Metadata:** Metadata associated with the selected image is displayed on the text area, such as steps, samplers, seeds, and more.
108
- * **Viewing Text:** The content of any text file associated with the selected image is displayed on the text box.
109
 
110
- ## Key Features
 
 
 
111
 
112
- * **Graphical User Interface (GUI):** Built with PyQt6 for a modern and cross-platform experience.
113
- * **Image Previews:** Quickly view images in a dedicated preview area.
114
- * **Metadata Extraction:** Extract and display relevant metadata from PNG image files, especially those generated from Stable Diffusion.
115
- * **Text Viewing:** Display the content of text files.
116
- * **Clear Layout:** A simple and intuitive layout, with list view on the left, and preview on the right.
117
 
118
- ## Future Developments
 
 
 
 
 
 
 
 
 
 
 
 
119
 
120
- * **Filtering/Sorting:** Options to filter and sort files.
121
- * **Thumbnail Generation:** Implement thumbnails for faster browsing.
122
- * **Themes:** Introduce customizable themes for appearance.
123
- * **Better User Experience:** Test on different operating systems and screen resolutions to optimize user experience.
124
- * **Video Tutorials:** Create video tutorials to show users how to use the program.
125
- * **Text Tutorials:** Create detailed tutorials in text and image to show the user how to use the program.
126
 
127
- ## Help the Creators
 
 
 
128
 
129
- <a href="https://discord.gg/5t2kYxt7An" target="_blank">
130
 
131
- ![A flat logo for Discord](https://img.shields.io/badge/%20Discord%20_%20_%20_%20_%20_%7C-_?style=flat-square&labelColor=rgb(65%2C69%2C191)&color=rgb(65%2C69%2C191))
 
 
132
 
133
- </a>
134
 
135
- ### --**__<{ Ktiseos Nyx }>__**--
136
 
137
- is a creator collective consisting of
 
 
 
 
138
 
 
139
 
 
 
 
140
 
 
141
 
 
 
 
 
142
 
143
- #### [Duskfall Portal Crew on GitHub](https://github.com/duskfallcrew)
144
 
145
- The Duskfall Portal crew would like to thank -
 
 
 
146
 
147
- * ChatGPT 3.5 & 4o: Powering innovative solutions and creative endeavors.
148
- * Support of my peers, and the community at Large.
149
- * [Canvas icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/canvas)
150
- * Inspired by [receyuki/stable-diffusion-prompt-reader](https://github.com/receyuki/stable-diffusion-prompt-reader)
151
 
152
- #### [EXDYSA on GitHub](https://github.com/exdysa)
 
 
153
 
154
- ...and more to come!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  - organization
9
  pretty_name: Dataset Tools
10
  ---
11
+ # Dataset Tools: An AI Metadata Viewer
12
 
13
+ <div align="center">
14
 
 
15
 
 
 
 
 
 
16
 
17
+ [![Dependency review](https://github.com/Ktiseos-Nyx/Dataset-Tools/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/Ktiseos-Nyx/Dataset-Tools/actions/workflows/dependency-review.yml) [![CodeQL](https://github.com/Ktiseos-Nyx/Dataset-Tools/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Ktiseos-Nyx/Dataset-Tools/actions/workflows/github-code-scanning/codeql) ![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
18
 
19
+ <hr>
20
+
21
+ [English Readme](https://github.com/Ktiseos-Nyx/Dataset-Tools/blob/main/README.md) [Wiki](https://github.com/Ktiseos-Nyx/Dataset-Tools/wiki) [Discussions](https://github.com/Ktiseos-Nyx/Dataset-Tools/discussions) [Notices](https://github.com/Ktiseos-Nyx/Dataset-Tools/blob/main/NOTICE.md) [License](https://github.com/Ktiseos-Nyx/Dataset-Tools/blob/main/LICENSE)
 
 
 
 
 
 
22
 
23
+ <hr>
24
+ Dataset Tools is a desktop application designed to help users browse and manage their image datasets, particularly those used with AI art generation tools (like Stable Diffusion WebUI Forge, A1111, ComfyUI) and model files (like Safetensors). Developed using Python and PyQt6, it provides an intuitive graphical interface for browsing files, viewing embedded generation parameters, and examining associated metadata.
25
 
26
+ This project is inspired by tools within the AI art community, notably [stable-diffusion-prompt-reader by receyuki](https://github.com/receyuki/stable-diffusion-prompt-reader), and aims to empower users in improving their dataset curation workflow. We welcome contributions; feel free to fork the repository and submit pull requests!
27
 
28
+ <hr>
29
 
30
+ ## Contact & Support Us
31
 
32
  <hr>
33
 
34
+ [![GitHub](https://img.shields.io/badge/GitHub-View%20on%20GitHub-181717?logo=github&style=for-the-badge)](https://github.com/Ktiseos-Nyx/Dataset-Tools) [![Discord](https://img.shields.io/discord/1024442483750490222?logo=discord&style=for-the-badge&color=5865F2)](https://discord.gg/HhBSvM9gBY) [![Twitch](https://img.shields.io/badge/Twitch-Follow%20on%20Twitch-9146FF?logo=twitch&style=for-the-badge)](https://twitch.tv/duskfallcrew) <a href="https://ko-fi.com/duskfallcrew" target="_blank"><img src="https://img.shields.io/badge/Support%20us%20on-Ko--Fi-FF5E5B?style=for-the-badge&logo=kofi" alt="Support us on Ko-fi"></a>
35
 
36
+ </div>
37
 
38
+ ---
39
 
40
+ **Navigation:**
41
+ [Features](#features) •
42
+ [Issues](#known-issues) •
43
+ [Supported Formats](#supported-formats) •
44
+ [Example Images](#example_images) •
45
+ [Installation](#installation) •
46
+ [Usage](#usage) •
47
+ [Themes](#themes) •
48
+ [Future Ideas (TODO)](#future-ideas-todo) •
49
+ [Contributing](#contributing) •
50
+ [License](#license) •
51
+ [Acknowledgements](#acknowledgements)
52
 
53
+ ---
54
 
55
+ ## Features
56
+
57
+ * **Lightweight & Fast:** Designed for quick loading and efficient metadata display.
58
+ * **Cross-Platform:** Built with Python and PyQt6 (compatible with Windows, macOS, Linux).
59
+ * **Comprehensive Metadata Viewing:**
60
+ * Clearly displays prompt information (positive, negative, SDXL-specific).
61
+ * Shows detailed generation parameters from various AI tools.
62
+ * **Intuitive File Handling:**
63
+ * **Drag and Drop:** Easily load single image files or entire folders. Dropped files are auto-selected.
64
+ * Folder browsing and file list navigation.
65
+ * **Image Preview:** Clear, rescalable preview for selected images.
66
+ * **Copy Metadata:** One-click copy of parsed metadata to the clipboard.
67
+ * **Themeable UI:** Supports themes via `qt-material` (e.g., dark_pink, light_lightgreen_500).
68
+ * **Advanced Metadata Engine:**
69
+ * **Completely Rebuilt Parser System:** New MetadataEngine with priority-based detection, robust Unicode handling, and comprehensive format support.
70
+ * **Enhanced ComfyUI Support:** Advanced workflow traversal, node connection analysis, and support for modern custom nodes (smZ CLIPTextEncode, etc.).
71
+ * **CivitAI Integration:** Full support for CivitAI's dual metadata formats with URN resource extraction and workflow parsing.
72
+ * **Bulletproof Unicode Handling:** Eliminates mojibake issues with comprehensive fallback chains and robust encoding detection.
73
+ * **A1111 Format Restoration:** Fixed and enhanced A1111 JPEG support with improved detection rules.
74
+ * **Intelligent Fallback System:** When specialized parsers can't handle a file, the system gracefully falls back to vendored parsers ensuring maximum compatibility.
75
+ * **25+ Specialized Parsers:** Dedicated parsers for various AI tools and platforms with ongoing expansion.
76
+ * **Model File Support:** Enhanced metadata viewing capabilities (Safetensors and GGUF support coming soon!).
77
+ * **Configurable Logging:** Control application log verbosity via command-line arguments for easier debugging.
78
+
79
+ ## Known Issues
80
+
81
+ * **Material Theme Compatibility:** The integrated `qt-material` themes, while visually appealing, are not 100% compatible with all PyQt6/Qt6 elements. While the application remains functional, some minor visual inconsistencies may be present. We are actively exploring alternatives and plan to migrate to Tkinter in the near future to address these and other compatibility challenges.
82
+ * **Advanced Parsers** Advanced parsing is about 75% of the way there. Currently we are struggling to get a lot of the T5 style models to parse in ComfyUI. If you or someone you know use ComfyUI and can pass any information about workflows, or what nodes you're currently using that'd be amazing.
83
+ * **Draw Things** The XMP Extractor MIGHT be working, but with limited data on DrawThings and the original vendored code not working at the moment we're unsure of how this is working.
84
+
85
+ ## Supported Formats
86
+
87
+ Dataset-Tools aims to read metadata from a wide array of sources. Current capabilities include:
88
+
89
+ **AI Image Metadata:**
90
+
91
+ * **A1111 webUI / Forge:** PNG (parameters chunk), JPEG/WEBP (UserComment).
92
+ * **ComfyUI:**
93
+ * Standard PNGs (embedded workflow JSON in "prompt" chunk).
94
+ * Civitai-generated JPEGs/PNGs (UserComment JSON with "extraMetadata").
95
+ * **Advanced ComfyUI Workflows:** While many workflows are supported, some complex or custom ComfyUI workflows may not be fully parsed yet. We are continuously working to improve compatibility. Please provide examples of unparsed workflows to help us improve!
96
+ * **NovelAI:** PNG (Legacy "Software" tag & "Comment" JSON; Stealth LSB in alpha channel).
97
+ * **Midjourney** Popularity rules! This is the old. gold standard of the old discord way (Shh I wrote this at 1 am)
98
+ * **InvokeAI:** (Currently undergoing refactoring, may not parse correctly in this version. Fixes planned for next major push.)
99
+ * **Easy Diffusion:** PNG, JPEG, WEBP (embedded JSON metadata).
100
+ * **Fooocus:** PNG ("Comment" chunk JSON), JPEG (JFIF comment JSON).
101
+ * **Midjourney** YAY
102
+ * **RuinedFooocus:** JPEG (UserComment JSON).
103
+ * **Draw Things:** (Currently undergoing refactoring, may not parse correctly in this version. Fixes planned for next major push.)
104
+ * **StableSwarmUI:** PNG, JPEG (EXIF or "sui_image_params" in PNG/UserComment).
105
+ * *(Support for other formats may be on the way, please see issues and/or discussions for details)*
106
+
107
+ ### File Types that are COMING SOON AND/or have partial capability
108
+
109
+ **Model File Metadata (Header Information):**
110
+
111
+ * `.safetensors`
112
+ * `.gguf`
113
+
114
+ **Other File Types:**
115
+
116
+ * `.txt`: Displays content.
117
+ * `.json`, `.toml`: Displays content (future: structured view).
118
+
119
+ ## Example Images
120
+ If you're interested in seeing the app in action, this table shows what's up!
121
+
122
+ | Screenshot 1: Dark QSS Themes | Screenshot 2: ConsoleStyle Gtronicks QSS | Screenshot 3: Font Choices |
123
+ | :-----------------------------: | :------------------------------: | :--------------------------: |
124
+ | <img src="example_images/Screenshot 2025-07-13 at 22.07.43.jpg" alt="GTRONICK QSS: Manjaromix" width="250"> | <img src="example_images/Screenshot 2025-07-13 at 20.02.22.jpg" alt="ConsoleStyle" width="250"> | <img src="example_images/Screenshot 2025-07-13 at 22.07.01.jpg" alt="Theme (Dark Teal) Choosing" width="250"> |
125
+ | Screenshot 4: Paimon Inspired | Screenshot 5: Material Blue | Screenshot 6: Deadpool Inspired |
126
+ | <img src="example_images/Screenshot 2025-07-13 at 20.01.54.jpg" alt="Screen Sizes" width="250"> | <img src="example_images/Screenshot 2025-07-13 at 20.01.15.jpg" alt="Civitai Metadata" width="250"> | <img src="example_images/Screenshot 2025-07-13 at 22.13.02.jpg" alt="Civitai Metadata" width="250">|
127
+
128
+ ## Installation
129
+
130
+ Installation is easy and is cross platform, there are no executables as those can create issues down the track when the developer isn't sure how that works. At the moment while we're still under heavy development the idea of having executables is months if not nearly a year down the track. However plans to push to package management systems beyond PYPI are entirely on track. Brew requirements will be the next push we work towards, as well as Windows and Linux compatible package managers!
131
+
132
+ ### 🚀 Quick Install (Recommended)
133
+
134
+ **One command and you're done:**
135
+
136
+ ```bash
137
+ pip install kn-dataset-tools
138
+ dataset-tools
139
+ ```
140
 
141
+ **Requirements:** Python 3.10 or newer
 
142
 
143
+ That's it! The tool will launch with a GUI interface for viewing AI metadata.
 
 
 
144
 
145
+ ---
146
 
147
+ ### 📦 Install from Source
148
 
149
+ If you want the latest development version:
150
 
151
+ ```bash
152
  git clone https://github.com/Ktiseos-Nyx/Dataset-Tools.git
153
+ cd Dataset-Tools
154
+ pip install .
155
+ dataset-tools
156
  ```
157
 
158
+ ---
159
 
160
+ ### 🔧 Advanced Installation (Optional)
161
+
162
+ For developers or users who prefer isolated environments:
163
+
164
+ <details>
165
+ <summary>Click to expand advanced options</summary>
166
+
167
+ **Using virtual environments:**
168
+
169
+ ```bash
170
+ # Create virtual environment
171
+ python -m venv dataset-tools-env
172
+
173
+ # Activate it
174
+ # Windows: dataset-tools-env\Scripts\activate
175
+ # macOS/Linux: source dataset-tools-env/bin/activate
176
+
177
+ # Install
178
+ pip install kn-dataset-tools
179
+ ```
180
+
181
+ **Using uv (fastest):**
182
+
183
+ ```bash
184
+ uv pip install kn-dataset-tools
185
+ ```
186
+
187
+ **For contributors:**
188
+
189
+ ```bash
190
+ git clone https://github.com/Ktiseos-Nyx/Dataset-Tools.git
191
  cd Dataset-Tools
192
+ pip install -e . # Editable install for development
193
  ```
194
 
195
+ </details>
 
 
 
 
 
196
 
197
+ ---
198
 
199
+ ### 🆚 vs SD Prompt Reader
200
+
201
+ Unlike SD Prompt Reader which focuses on basic prompt viewing, Dataset Tools provides:
202
+
203
+ * Advanced ComfyUI workflow analysis
204
+ * LoRA training metadata extraction
205
+ * 25+ specialized AI format parsers
206
+ * Model file support (SafeTensors, GGUF)
207
+ * Comprehensive metadata engine
208
+
209
+ **Both tools are great!** Use whichever fits your workflow better.
210
+
211
+ ## Usage
212
+
213
+ ### Launching the Application
214
+
215
+ ```bash
216
+ python dataset_tools
217
  ```
218
 
219
+ **After installation, run the application from your terminal:**
220
 
221
+ ```bash
222
+ dataset-tools
223
+ ```
224
 
225
+ #### Advanced Command-line Options
 
226
 
227
+ ```bash
228
+ python -m dataset_tools.main [options]
229
+ ```
230
 
231
+ > [!TIP]
232
+ >
233
+ > ```bash
234
+ > --log-level LEVEL: Sets the logging verbosity.
235
+ > ```
236
+ >
237
+ > Choices: DEBUG, INFO (default), WARNING, ERROR, CRITICAL.
238
+ > Short forms: d, i, w, e, c (case-insensitive).
239
+ >
240
+ > ```bash
241
+ > Example: python -m dataset_tools.main --log-level DEBUG
242
+ > ```
243
 
244
+ #### GUI Interaction
245
 
246
+ **Loading Files:**
 
 
247
 
248
+ 1. Click the "Open Folder" button or use the File > Change Folder... menu option.
249
+ 2. Drag and Drop: Drag a single image/model file or an entire folder directly onto the application window.
250
+ 3. If a single file is dropped, its parent folder will be loaded, and the file will be automatically selected in the list.
251
+ 4. If a folder is dropped, that folder will be loaded.
252
 
253
+ **Navigation:**
 
 
 
 
254
 
255
+ 1. Select files from the list on the left panel to view their details.
256
+ * Image Preview:
257
+ Selected images are displayed in the preview area on the right.
258
+ Non-image files or files that cannot be previewed will show a "No preview available" message.
259
+ * Metadata Display:
260
+ Parsed prompts (Positive, Negative), generation parameters (Steps, Sampler, CFG, Seed, etc.), and other relevant metadata are shown in the text areas below/beside the image preview.
261
+ The Prompt Info and Generation Info section titles will update based on the content found.
262
+ * Copy Metadata:
263
+ Use the "Copy Metadata" button to copy the currently displayed parsed metadata (from the text areas) to your system clipboard.
264
+ * File List Actions:
265
+ Sort Files: Click the "Sort Files" button to sort the items in the file list alphabetically by type (images, then text, then models).
266
+ * Settings & Themes:
267
+ Access application settings (e.g., display theme, window size preferences) via the "Settings..." button at the bottom or the View > Themes menu for quick theme changes.
268
 
269
+ ### Themes
 
 
 
 
 
270
 
271
+ A massive selection of horrifying and eye catching, eye tearing, and meme worthy themes are currently available in the app in QSS form for the PYQT6 branch only.
272
+ Future development will include Tkinter themes in a similar format. Please note, that the main developer of this app has 0 clue how QSS entirely works, and just wanted to provide some good and some bad themes.
273
+ You can use these for yourself by heading over to [QSS Themes](https://github.com/Ktiseos-Nyx/qss_themes/). You should be able to use your own QSS style sheets in the themes folder. Our insanity is not required, and you do not have to thank us.
274
+ Yes, theres is a disclaimer file for theme information and we do not own any of the names, brands or concepts within them. Nor are we intentionally being offensive, trust me on this - nobody will shame you for using the theme "Colors only a Mother Would Love" you know you want to.
275
 
276
+ We are also using the following imported themes:
277
 
278
+ * [GTRONICKS](https://github.com/GTRONICK/QSS)
279
+ * [UNREAL STYLESHEET](https://github.com/leixingyu/unrealStylesheet)
280
+ * [DUNDERLAB QT MATERIAL STYLESHEETS](https://github.com/dunderlab/qt-material)
281
 
282
+ ### Future Development Roadmap
283
 
284
+ **Core Features:**
285
 
286
+ * [ ] **Model File Support:** Complete Safetensors and GGUF metadata display and editing capabilities.
287
+ * [ ] **Full Metadata Editing:** Advanced editing and saving capabilities for image metadata.
288
+ * [ ] **Plugin Architecture:** Extensible plugin system for easy addition of custom parsers and functionality.
289
+ * [ ] **Batch Operations:** Export metadata from folders, rename files based on metadata, bulk processing.
290
+ * [ ] **Advanced Search & Filtering:** Dataset search and filtering based on metadata content and parameters.
291
 
292
+ **User Experience:**
293
 
294
+ * [ ] **Enhanced UI/UX:** Improved prompt display, better text file viewing with syntax highlighting. (Planned migration to Tkinter for improved cross-platform compatibility and UI consistency.)
295
+ * [ ] **Theme System Expansion:** Additional themes and customization options.
296
+ * [ ] **Keyboard Shortcuts:** Comprehensive hotkey support for power users.
297
 
298
+ **Platform & Integration:**
299
 
300
+ * [ ] **Standalone Executables:** Native builds for Windows, macOS, and Linux.
301
+ * [ ] **PyPI Distribution:** Official package distribution for easy `pip install dataset-tools`.
302
+ * [ ] **CivitAI API Integration:** Direct model and resource lookup capabilities.
303
+ * [ ] **Cross-Platform Compatibility:** Enhanced support across different operating systems.
304
 
305
+ **Technical Improvements:**
306
 
307
+ * [ ] **Comprehensive Test Suite:** Automated testing to ensure stability and prevent regressions.
308
+ * [ ] **Enhanced Format Support:** Additional AI tool formats and metadata standards.
309
+ * [ ] **Performance Optimization:** Faster loading and processing for large datasets.
310
+ * [ ] **Error Handling:** Improved error reporting and recovery mechanisms.
311
 
312
+ **Ecosystem Integration:**
 
 
 
313
 
314
+ * [ ] **Dataset Management Tools:** Integration with HuggingFace, model downloaders, and conversion utilities.
315
+ * [ ] **Workflow Integration:** Support for AI generation workflows and pipeline management.
316
+ * [ ] **Community Features:** Parser sharing, format contribution system.
317
 
318
+ ## Contributing
319
+
320
+ Your contributions are welcome! Whether it's bug reports, feature requests, documentation improvements, or code contributions, please feel free to get involved.
321
+
322
+ * Issues: Please check the issues tab for existing bugs or ideas. If you don't see your issue, please open a new one with a clear description and steps to reproduce (for bugs).
323
+ * Pull Requests:
324
+ Fork the repository.
325
+ Create a new branch for your feature or bugfix (git checkout -b feature/your-feature-name or bugfix/issue-number).
326
+ Make your changes and commit them with clear, descriptive messages.
327
+ Push your branch to your fork (git push origin feature/your-feature-name).
328
+ Submit a pull request to the main branch of the Ktiseos-Nyx/Dataset-Tools repository. Please provide a clear description of your changes in the PR.
329
+
330
+ ## License
331
+
332
+ This project is licensed under the terms of the GNU GENERAL PUBLIC LICENSE [GPL 3.0](https://github.com/Ktiseos-Nyx/Dataset-Tools/blob/Themes-Lost-Dreams/LICENSE)
333
+ Please see the LICENSE file in the repository root for the full license text.
334
+
335
+ ## Acknowledgements
336
+
337
+ * Core Parsing Logic & Inspiration: This project incorporates and significantly adapts parsing functionalities from Stable Diffusion Prompt Reader by **[receyuki](https://github.com/receyuki)** . Our sincere thanks for this foundational work.
338
+ Original Repository: [stable-diffusion-prompt-reader](https://github.com/receyuki/stable-diffusion-prompt-reader)
339
+ The original MIT license for this vendored code is included in the NOTICE.md file.
340
+ * UI Theming: The beautiful PyQt themes are made possible by [qt-material](https://github.com/dunderlab/qt-material) by [DunderLab](https://github.com/dunderlab) as well as GTRONICK - [GTRONICKS](https://github.com/GTRONICK/QSS) and the UNREAL STYLE SHEET Creator [UNREAL STYLESHEET](https://github.com/leixingyu/unrealStylesheet)
341
+ * Essential Libraries: This project relies on great open-source Python libraries including [Pillow,](https://github.com/python-pillow/Pillow), [PyQt6](https://www.riverbankcomputing.com/software/pyqt/), [piexif](https://github.com/hMatoba/Piexif), [pyexiv2](https://github.com/LeoHsiao1/pyexiv2), [toml](https://github.com/uiri/toml), [Pydantic](https://docs.pydantic.dev/latest/), and [Rich](https://github.com/Textualize/rich). Their respective licenses apply.
342
+ * **[Anzhc](https://github.com/anzhc)** for continued support and motivation.
343
+ * Our peers and the wider AI and open-source communities for their continuous support and inspiration.
344
+ * AI Language Models (like those from Google, OpenAI, Anthropic) for assistance with code generation, documentation, and problem-solving during development.
345
+ * ...and many more!
346
+
347
+ <hr>
348
+
349
+ ## Support Us
350
+
351
+ If you find Dataset Tools useful, please consider supporting the creators!
352
+
353
+ <a href="https://discord.gg/HhBSvM9gBY" target="_blank"><img src="https://img.shields.io/badge/Join%20us%20on-Discord-5865F2?style=for-the-badge&logo=discord" alt="Join us on Discord"></a>
354
+ <a href="https://ko-fi.com/duskfallcrew" target="_blank"><img src="https://img.shields.io/badge/Support%20us%20on-Ko--Fi-FF5E5B?style=for-the-badge&logo=kofi" alt="Support us on Ko-fi"></a>
355
+ <a href="https://twitch.tv/duskfallcrew" target="_blank"><img src="https://img.shields.io/badge/Follow%20us%20on-Twitch-9146FF?style=for-the-badge&logo=twitch" alt="Follow us on Twitch"></a>
356
+
357
+ <hr>