Add PyQt6 multi-file GUI for MarkItDown

Author: rahulpwar654

MARKITDOWN_GUI_SETUP.md

@@ -0,0 +1,115 @@
+# MarkItDown GUI Setup and Run Guide
+
+This guide explains how to install dependencies and run the `markitdown-gui` desktop app.
+
+## 1. Prerequisites
+
+- Python 3.10+
+- PowerShell (Windows)
+- This repository cloned locally
+
+## 2. Open the Project Folder
+
+```powershell
+cd D:\develpment\FileConverterToMD
+```
+
+## 3. Create and Activate Virtual Environment
+
+```powershell
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+```
+
+If script execution is blocked in PowerShell, run:
+
+```powershell
+Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
+.\.venv\Scripts\Activate.ps1
+```
+
+## 4. Install MarkItDown with GUI + DOCX Support
+
+Recommended for GUI and Word files (`.docx`):
+
+```powershell
+pip install -e "packages/markitdown[gui,docx]"
+```
+
+Install all optional converters instead:
+
+```powershell
+pip install -e "packages/markitdown[all,gui]"
+```
+
+## 5. Run the GUI
+
+Option A (dedicated command):
+
+```powershell
+markitdown-gui
+```
+
+Option B (through main CLI):
+
+```powershell
+markitdown --gui
+```
+
+## 6. Convert Files in the GUI
+
+1. Click **Select Files** and choose one or more files.
+2. Choose output mode:
+   - Keep **Save next to each source file** enabled, or
+   - Disable it and select an **Output folder**.
+3. Click **Convert to Markdown**.
+4. Check the log panel for success/error messages.
+
+Each selected input file produces one `.md` output file.
+
+## 7. Quick Verification (Optional)
+
+Check CLI install:
+
+```powershell
+markitdown --version
+```
+
+Quick single-file conversion test:
+
+```powershell
+markitdown "D:\path\to\file.docx" -o "D:\path\to\file.md"
+```
+
+## Troubleshooting
+
+### Error: MissingDependencyException for `.docx`
+
+Install DOCX dependencies:
+
+```powershell
+pip install -e "packages/markitdown[docx]"
+```
+
+or
+
+```powershell
+pip install -e "packages/markitdown[gui,docx]"
+```
+
+### Error on reinstall: Access denied for `markitdown-gui.exe`
+
+Close any running GUI window, then reinstall:
+
+```powershell
+pip install -e "packages/markitdown[gui,docx]"
+```
+
+### Command not found (`markitdown-gui`)
+
+- Ensure virtual environment is activated.
+- Reinstall package in editable mode:
+
+```powershell
+pip install -e "packages/markitdown[gui,docx]"
+```

README.md

@@ -88,6 +88,28 @@ You can also pipe content:
 cat path-to-file.pdf | markitdown
 ```
 
+### Desktop UI (PyQt6)
+
+Install with GUI support:
+
+```bash
+pip install 'markitdown[gui]'
+```
+
+Then launch:
+
+```bash
+markitdown-gui
+```
+
+You can also launch the same UI from the main CLI:
+
+```bash
+markitdown --gui
+```
+
+The UI supports selecting multiple files at once and writes one `.md` output per input file.
+
 ### Optional Dependencies
 MarkItDown has optional dependencies for activating various file formats. Earlier in this document, we installed all optional dependencies with the `[all]` option. However, you can also install them individually for more control. For example:
 
@@ -100,6 +122,7 @@ will install only the dependencies for PDF, DOCX, and PPTX files.
 At the moment, the following optional dependencies are available:
 
 * `[all]` Installs all optional dependencies
+* `[gui]` Installs dependencies for the PyQt6 desktop UI (multi-file conversion)
 * `[pptx]` Installs dependencies for PowerPoint files
 * `[docx]` Installs dependencies for Word files
 * `[xlsx]` Installs dependencies for Excel files

packages/markitdown/README.md

@@ -32,6 +32,28 @@ pip install -e 'packages/markitdown[all]'
 markitdown path-to-file.pdf > document.md
 ```
 
+### Desktop UI (PyQt6)
+
+Install the GUI extra:
+
+```bash
+pip install 'markitdown[gui]'
+```
+
+Launch the desktop app:
+
+```bash
+markitdown-gui
+```
+
+Or from the main CLI:
+
+```bash
+markitdown --gui
+```
+
+The desktop UI lets you select multiple files in one operation and converts each file to a `.md` Markdown file.
+
 ### Python API
 
 ```python

packages/markitdown/pyproject.toml

@@ -50,6 +50,7 @@ all = [
   "azure-ai-contentunderstanding>=1.2.0b1",
   "azure-identity",
 ]
+gui = ["PyQt6"]
 pptx = ["python-pptx"]
 docx = ["mammoth~=1.11.0", "lxml"]
 xlsx = ["pandas", "openpyxl"]
@@ -72,6 +73,7 @@ path = "src/markitdown/__about__.py"
 
 [project.scripts]
 markitdown = "markitdown.__main__:main"
+markitdown-gui = "markitdown._qt_gui:main"
 
 [tool.hatch.envs.default]
 features = ["all"]

packages/markitdown/src/markitdown/__main__.py

@@ -138,9 +138,21 @@ def main():
         help="Keep data URIs (like base64-encoded images) in the output. By default, data URIs are truncated.",
     )
 
+    parser.add_argument(
+        "--gui",
+        action="store_true",
+        help="Launch the PyQt6 desktop UI for selecting and converting multiple files.",
+    )
+
     parser.add_argument("filename", nargs="?")
     args = parser.parse_args()
 
+    if args.gui:
+        from ._qt_gui import main as gui_main
+
+        gui_main()
+        return
+
     # Parse the extension hint
     extension_hint = args.extension
     if extension_hint is not None: