https://github.com/germabyte/chatlog-cleaner
chatlog-cleaner.py is a user-friendly program designed to streamline the process of cleaning and organizing markdown files generated from ChatGPT conversations. If you frequently work with markdown files containing dialogue, this tool helps by removing user inputs and retaining only ChatGPT's or Assistant's responses.
https://github.com/germabyte/chatlog-cleaner
automation chatgpt cleaning data-cleaning file-processing gui markdown python text-processing tkinter utility
Last synced: 4 months ago
JSON representation
chatlog-cleaner.py is a user-friendly program designed to streamline the process of cleaning and organizing markdown files generated from ChatGPT conversations. If you frequently work with markdown files containing dialogue, this tool helps by removing user inputs and retaining only ChatGPT's or Assistant's responses.
- Host: GitHub
- URL: https://github.com/germabyte/chatlog-cleaner
- Owner: germabyte
- Created: 2025-01-02T22:11:38.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-04T14:09:18.000Z (9 months ago)
- Last Synced: 2025-01-18T21:04:44.652Z (9 months ago)
- Topics: automation, chatgpt, cleaning, data-cleaning, file-processing, gui, markdown, python, text-processing, tkinter, utility
- Language: Python
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ChatGPT Cleaner
## 1. Introduction and Purpose
### 🧩 Introduction
**ChatGPT Cleaner** is a simple desktop application designed to clean `.md` files exported from ChatGPT conversations. It removes all user messages while preserving only the AI-generated responses.
### âť“ Purpose & Problem Statement
When exporting conversations from ChatGPT or tools like `chat2markdown.py`, the output includes both user and assistant messages. For users who wish to keep only the assistant's responses (for documentation, publishing, or archiving), manually editing these logs can be tedious.
### 🎯 Value Proposition
This tool streamlines that process by automatically:
- Removing user messages.
- Preserving only ChatGPT or Assistant messages.
- Providing a visual preview and save feature.
- Supporting batch processing of multiple `.md` files at once.
---
## 2. Dependencies (Required Software/Libraries)
### âś… Required:
| Dependency | Description | Installation |
|------------|-------------|--------------|
| **Python** (version 3.x) | Required to run the program. Python is the language this script is written in. | [Download Python from the official website](https://www.python.org/downloads/) |
| **tkinter** | Used to create the graphical user interface (GUI). Included by default with most Python distributions. | No action required if using standard Python. |
> âś… **No other third-party libraries or installations are required.**
---
## 3. Getting Started (Installation & Execution)
### đź“Ą Step-by-Step Instructions
1. **Download the Repository**
- Click the green `<> Code` button on GitHub.
- Select `Download ZIP`.
- Extract the ZIP file to a folder of your choice.
2. **Run the Application**
- Make sure Python is installed on your system.
- Open your terminal or command prompt:
- **Windows:** Press `Win + R`, type `cmd`, press Enter.
- **macOS/Linux:** Use Spotlight/Search to open "Terminal".
- Navigate to the extracted folder:
```bash
cd path/to/extracted-folder
```
- Launch the program using:
```bash
python chatlog-cleaner.py
```
> A window will open with buttons to select, clean, preview, and save cleaned chat logs.
---
## 4. User Guide (How to Effectively Use the Program)
### 🖱️ How to Use the GUI
1. **Click "Select .md Files"**
- Browse and select one or more markdown files exported from ChatGPT or `chat2markdown.py`.
2. **Click "Clean Content"**
- The program will process the selected files.
- All user messages (`"#### You:"`, `"**User:**"`, etc.) are removed.
- ChatGPT responses (`"#### ChatGPT:"`, `"**ChatGPT:**"`, `"**Assistant:**"`) are retained.
3. **Preview Cleaned Output**
- The main text box will show the cleaned version of each file.
4. **Click "Save Cleaned Files"**
- Choose a folder to save the cleaned `.md` files.
- Cleaned versions will be named with `_cleaned` appended to the original filename.
---
## 5. Use Cases and Real-World Examples
### âś… Use Case 1: Blog Post Preparation
**Scenario:** A user wants to publish ChatGPT responses in a blog post without showing their original prompts.
**Input:** Markdown file with alternating `#### You:` and `#### ChatGPT:` sections.
**Output:** A file that includes only the `#### ChatGPT:` responses, ready for blog formatting.
---
### âś… Use Case 2: Academic Research Documentation
**Scenario:** A researcher uses ChatGPT for generating summaries and needs clean logs for their appendix.
**Input:** File using `**User:**` and `**ChatGPT:**` from `chat2markdown.py`.
**Output:** Only the assistant responses remain, making the file suitable for referencing in reports.
---
### âś… Use Case 3: Personal Journal Archive
**Scenario:** A user keeps a personal AI conversation journal and wants to reflect on AI insights without seeing their own inputs.
**Input:** Exported markdown file from ChatGPT Playground.
**Output:** A cleaned, assistant-only log stored in a personal archive.
---
## 6. Disclaimer & Important Notices
- The repository and its contents may be updated at any time without notice.
- Such updates may render parts of this README file obsolete.
- No commitment is made to maintain or update this README to reflect future changes.
- The provided code is delivered "as-is," and no guarantees—explicit or implied—are made regarding functionality, reliability, compatibility, or correctness.