chat-export 0.9.2__py3-none-any.whl

chat_export-0.9.2.dist-info/METADATA

@@ -0,0 +1,264 @@
+Metadata-Version: 2.4
+Name: chat-export
+Version: 0.9.2
+Summary: Convert WhatsApp chat exports to HTML format
+Author-email: matlon GmbH <software@matlon.ch>
+License: MIT License
+        
+        Copyright (c) 2024 mtln
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://chat-export.click
+Project-URL: Repository, https://github.com/mtln/chat-export
+Project-URL: Issues, https://github.com/mtln/chat-export/issues
+Project-URL: Donate, https://donate.stripe.com/3csfZLaIj5JE6dO4gg
+Keywords: whatsapp,chat,export,html,conversion,archive
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Topic :: Utilities
+Classifier: Topic :: System :: Archiving
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: macos
+Requires-Dist: pyobjc-framework-Cocoa>=9.0; extra == "macos"
+Provides-Extra: windows
+Requires-Dist: pywin32>=306; extra == "windows"
+Dynamic: license-file
+
+# chat-export: Convert WhatsApp Chats to HTML
+
+This tool converts a WhatsApp chat export into two HTML formats: one with inline media (such as images, videos, and audio files) and a compact version with media links.
+
+
+Video Tutorial (still refers to the previously used tool name instead of `chat-export`):  
+[![YouTube](https://img.youtube.com/vi/s1dMO8pjkC8/0.jpg)](https://www.youtube.com/watch?v=s1dMO8pjkC8)"
+
+## Binary Release Downloads
+* Windows: [chat-export.exe](https://github.com/mtln/chat-export/releases/latest/download/chat-export.exe)
+* Mac: [chat-export-installer.pkg](https://github.com/mtln/chat-export/releases/latest/download/chat-export-installer.pkg)
+
+
+## Why is this useful?
+The HTML export is:
+
+* **Printable:** You can print the chat or save as a PDF.
+* **Searchable:** You can search for specific messages in the browser.
+* **Shareable:** You can share the chat with others, but make sure to get consent from all other participants first.
+* **Durable:** You can keep the chat as a record for years to come. Apps come and go. Plain HTML is here to stay.
+* **Automatable:** With the non-interactive CLI mode, you can script batch processing of multiple chat exports or integrate the tool into other workflows.
+
+Maybe you want to:
+
+* keep a record of a conversation with a former loved one, friend, or business partner. You want to delete the chat from your phone, but you don’t want to lose the memories.
+* save a chat with important information, such as addresses, phone numbers, or other data.
+* keep a chat with a person who has passed away.
+* export just an excerpt of a chat from a specific date range.
+* archive a chat before freeing up space on your phone by deleting photos, videos, and other documents that were part of the chat.
+* ask another chat participant who still has a complete version of the chat (including all pictures) on his or her phone to send you a chat export, so you can convert and archive it.
+* batch process multiple chat exports automatically using the CLI mode.
+* integrate chat conversion into backup or archival scripts.
+* process chat exports on headless servers or in automated workflows.
+
+Furthermore, the tool is [open-source](https://github.com/mtln/chat-export) and runs offline on your computer, so you can be sure that your data is not being sent to any server.  
+And by the way, it’s free! If you find it useful, you can [donate](https://donate.stripe.com/3csfZLaIj5JE6dO4gg).
+
+## Instructions
+
+1. **Export the Chat:** Begin by exporting a chat from the WhatsApp app, preferably with media included. For detailed instructions, refer to [WhatsApp FAQ](https://faq.whatsapp.com/search?helpref=search&query=%20export%20chat).
+You can for example save it on Google Drive or Dropbox or send it to yourself with WhatsApp.
+
+2. **Transfer the File:** Move the exported ZIP file to your computer. If you have sent it to yourself with WhatsApp, you can download it with WhatsApp Web or with the WhatsApp App on your computer. Delete the WhatsApp message afterwards to save space.
+
+3. **Install and Run the Tool:** 
+
+   **Option 1: Install via pip (Recommended)**
+   
+   If you have Python installed, you can install chat-export as a command-line tool:
+   ```
+   pip install chat-export
+   ```
+   
+   **Optional: Install with platform-specific dependencies for native file dialogs**
+   
+   For better user experience with native file picker dialogs, you can install platform-specific dependencies:
+   
+   **On macOS:**
+   ```
+   pip install chat-export[macos]
+   ```
+   
+   **On Windows:**
+   ```
+   pip install chat-export[windows]
+   ```
+   
+   
+   
+   *Note: Without these optional dependencies, the tool will fall back to command-line input for file selection or use tkinter (if available) for file dialogs. If you're planning to use the tool in non-interactive mode, you don't need to install these dependencies.*
+   
+   After installation, you can run it from anywhere in your terminal:
+   
+   ```
+   chat-export
+   chat-export --help
+   ```
+   
+   To uninstall:
+   ```
+   pip uninstall chat-export
+   ```
+
+   **Option 2: Download Binary Executables**
+   
+   - For Windows, download [chat-export.exe](https://github.com/mtln/chat-export/releases/latest/download/chat-export.exe).
+
+   Because the .exe is unsigned, you will see a warning, but after clicking on "More Information" you should have the option to run it anyway. An EV code signing certificate for Windows costs a lot. If I get enough donations, I will buy one, so I can release signed exe files.
+
+   - For Mac, download [chat-export-installer.pkg](https://github.com/mtln/chat-export/releases/latest/download/chat-export-installer.pkg)
+
+   Once installed on Mac:
+   1. Open the **Terminal** app (e.g. by typing "terminal" in Spotlight Search).
+   2. Type: `chat-export`
+    
+   This will start the chat export tool from anywhere in the terminal.
+
+   To uninstall `chat-export` from Mac, open the Terminal and run: `sudo rm /usr/local/bin/chat-export`
+
+   The executables have been built with pyinstaller.
+
+   **Option 3: Run Directly (No Installation)**
+   
+   If Python is installed on your Windows, Mac or Linux computer, run the tool directly (no installation required) with the following command:
+     ```
+     python -c "import urllib.request; exec(urllib.request.urlopen('https://raw.githubusercontent.com/mtln/chat-export/refs/heads/main/main.py').read().decode())"
+     ```
+     or
+     ```
+     python3 -c "import urllib.request; exec(urllib.request.urlopen('https://raw.githubusercontent.com/mtln/chat-export/refs/heads/main/main.py').read().decode())"
+     ```
+
+**Usage**
+
+The tool supports both interactive and non-interactive modes:
+
+### Interactive Mode (Default)
+**CLI Parameters:**
+
+`-o, --output-dir`: Base directory where the chat folder will be created (optional, default: current directory)
+
+
+* After starting the tool, a file picker dialog will open. Select the ZIP file of the chat export you want to convert. If your installation does not support file dialogs, you will be prompted for the path to the ZIP file.
+* You can enter start and end dates to export only a specific date range. If you leave the fields empty, the entire chat will be exported. **If the terminal window doesn't accept your keyboard input, click with your mouse right after the colon in `Enter the number corresponding to your name:`** to set the focus to the terminal window.
+* A list of chat participants will appear. Select your name so that your messages are displayed in green chat bubbles, just like on WhatsApp.
+* Once the conversion completes, you can choose to open the HTML files immediately in your browser (just hit enter). From there, you can save the chat as a PDF or print it if needed.
+
+### Command Line Interface (Non-Interactive Mode)
+
+For automation, scripting, or when you know all parameters in advance, you can use the non-interactive CLI mode. This mode processes the chat without any prompts and is perfect for batch processing or integration into other tools.
+
+**Basic Usage:**
+```
+chat-export -n -z "path/to/chat.zip" -p "Your Name"
+```
+
+**CLI Parameters:**
+
+- `-n, --non-interactive`: Enable non-interactive mode (required)
+- `-z, --zip-file`: Path to WhatsApp chat export ZIP file (required)
+- `-p, --participant`: Your name exactly as it appears in the chat (required)
+- `--from-date`: Optional start date for filtering (formats: DD.MM.YYYY, MM/DD/YYYY, DD.MM.YY, MM/DD/YY)
+- `--until-date`: Optional end date for filtering
+- `-o, --output-dir`: Base directory where the chat folder will be created (default: current directory)
+
+
+**Examples:**
+
+Basic conversion:
+```
+chat-export -n -z "WhatsApp Chat with John.zip" -p "Your Name"
+```
+With absolute path to ZIP file (Windows):
+```
+chat-export -n -z "c:\temp\WhatsApp Chat with John.zip" -p "Your Name"
+```
+
+With date filtering:
+```
+chat-export -n -z "chat.zip" -p "Your Name" --from-date "01.01.2024" --until-date "31.12.2024"
+```
+
+Custom output directory (creates chat folder in /tmp instead of current directory):
+```
+chat-export -n -z "chat.zip" -p "Your Name" -o "/tmp"
+```
+
+Windows paths (important: no trailing backslash):
+```
+chat-export -n -z "chat.zip" -p "Your Name" -o "C:\temp"
+```
+
+**Important Notes:**
+- The participant name must match exactly as it appears in the chat (case-sensitive)
+- If the participant name is not found, the tool will display all available participants and exit
+
+
+* When printing an HTML page, most web browsers are set by default to exclude background colors to save ink or toner. If you want to include them, you need to enable background graphics in your browser settings. See the section below for instructions. 
+   * **In Google Chrome**: Go to `Print` → `More settings` → Check `Background graphics`.
+   * **In Mozilla Firefox**: Go to `File` → `Print` → `Page Setup` → Check `Print Background (colors & images)`.
+   * **In Microsoft Edge**: Go to `Print` → `More settings` → Check `Background graphics`.
+
+
+## Supported languages
+WhatsApp chat exports vary depending on your phone’s system language. 
+
+chat-export has been tested with many languages and regional settings.
+
+If it doesn't work for your language, please let me know.
+
+## Supported Operating Systems
+
+* Windows
+* Mac
+* Linux
+
+## Limitations
+There is information in chats, that is not included in the export.zip created by WhatsApp. As a consequence, this information cannot be rendered by chat-export.
+
+This includes:
+
+* Reactions (thumbs up and other emojis that are not a stand-alone message, but created by long tapping a previous message)
+* Message relations (in WhatsApp, you can right-swipe a previous message and then write a message in relation to this)
+* Chat group metadata (e.g. list of all members, admins, ...)
+
+## Disclaimer
+chat-export comes with no warranty. Use it responsibly and respect the privacy of other chat participants. The tool is not affiliated with WhatsApp or Meta.

chat_export-0.9.2.dist-info/RECORD

@@ -0,0 +1,7 @@
+main.py,sha256=PB5ne3mRoMTAruJTaj01WCahVrxZ4wDvE_EOeYJFH_Y,51061
+chat_export-0.9.2.dist-info/licenses/LICENSE,sha256=7b3yA-zEQNXQ6nAKtcZMYmr4PiR5EwHTw-gTt3CA7vI,1082
+chat_export-0.9.2.dist-info/METADATA,sha256=F4i1zfJKMUzRm2x3nOibKAleTy4pmejUj5gXRNMYQ3E,12915
+chat_export-0.9.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+chat_export-0.9.2.dist-info/entry_points.txt,sha256=DnUhZ4Gw8H5jR3a8RI4IcdMPf-3umNLUizHMbA1aruA,42
+chat_export-0.9.2.dist-info/top_level.txt,sha256=ZAMgPdWghn6xTRBO6Kc3ML1y3ZrZLnjZlqbboKXc_AE,5
+chat_export-0.9.2.dist-info/RECORD,,

chat_export-0.9.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

chat_export-0.9.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+chat-export = main:main

chat_export-0.9.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 mtln
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

chat_export-0.9.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+main