convoviz 0.4.2__py3-none-any.whl → 0.4.4__py3-none-any.whl

convoviz/cli.py

@@ -1,6 +1,7 @@
 """Command-line interface for convoviz."""
 
 import logging
+from importlib.metadata import version as get_version
 from pathlib import Path
 
 import typer
@@ -22,6 +23,13 @@ app = typer.Typer(
 console = Console()
 
 
+def _version_callback(value: bool) -> None:
+    """Print version and exit."""
+    if value:
+        console.print(f"convoviz {get_version('convoviz')}")
+        raise typer.Exit()
+
+
 @app.callback(invoke_without_command=True)
 def run(
     ctx: typer.Context,
@@ -71,6 +79,14 @@ def run(
         "--log-file",
         help="Path to log file. Defaults to a temporary file.",
     ),
+    _version: bool = typer.Option(
+        False,
+        "--version",
+        "-V",
+        help="Show version and exit.",
+        callback=_version_callback,
+        is_eager=True,
+    ),
 ) -> None:
     """Convert ChatGPT export data to markdown and generate visualizations."""
     # Setup logging immediately

{convoviz-0.4.2.dist-info → convoviz-0.4.4.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: convoviz
-Version: 0.4.2
-Summary: Get analytics and visualizations on your ChatGPT data!
+Version: 0.4.4
+Summary: Convert your ChatGPT export (ZIP) into clean Markdown text files with inline media, and generate data visualizations like word clouds and usage graphs.
 Keywords: markdown,chatgpt,openai,visualization,analytics,json,export,data-analysis,obsidian
 Author: Mohamed Cheikh Sidiya
 Author-email: Mohamed Cheikh Sidiya <mohamedcheikhsidiya77@gmail.com>
@@ -27,7 +27,12 @@ Description-Content-Type: text/markdown
   <h1 align="center">Convoviz 📊</h1>
   <p align="center"><strong>Visualize your entire ChatGPT data</strong></p>
   <p align="center">
-    Convert your ChatGPT history into well-formatted Markdown files.<br>
+    Convert your ChatGPT history into clean, readable Markdown (text files).
+  </p>
+  <p align="center"><strong>
+    Perfect for archiving, local search, or use with note-taking apps like Obsidian.
+  </strong></p>
+  <p align="center">
     Visualize your data with word clouds 🔡☁️ and usage graphs 📈.
   </p>
 </p>
@@ -35,7 +40,7 @@ Description-Content-Type: text/markdown
 <p align="center">
   <a href="https://pypi.org/project/convoviz/"><img src="https://img.shields.io/pypi/v/convoviz?style=for-the-badge&logo=python&logoColor=white" alt="PyPI Version"></a>
   <a href="https://github.com/mohamed-chs/convoviz/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/convoviz?style=for-the-badge" alt="License"></a>
-  <a href="https://pepy.tech/projects/convoviz"><img src="https://img.shields.io/pepy/dt/convoviz?style=for-the-badge" alt="Downloads"></a>
+  <a href="https://pepy.tech/projects/convoviz"><img src="https://img.shields.io/pepy/dt/convoviz?style=for-the-badge&color=blue" alt="Downloads"></a>
   <a href="https://github.com/mohamed-chs/convoviz/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/mohamed-chs/convoviz/ci.yml?style=for-the-badge&logo=github&label=CI" alt="CI Status"></a>
 </p>
 
@@ -50,7 +55,7 @@ Description-Content-Type: text/markdown
 | ☁️ **Word Clouds** | Visual breakdowns of your most-used words and phrases |
 | 📈 **Usage Graphs** | Bar plots and charts showing your conversation patterns |
 
-> 💡 **See examples in the [`demo/`](demo) folder!**
+> 💡 **See examples in the [`demo/`](https://github.com/mohamed-chs/convoviz/tree/main/demo) folder!**
 
 ---
 
@@ -67,25 +72,29 @@ Description-Content-Type: text/markdown
 
 ### Step 2: Install Convoviz
 
-<details open>
-<summary><strong>🚀 Quick Install (Recommended)</strong></summary>
+### 🚀 Quick Install
 
-One command installs everything you need — [uv](https://github.com/astral-sh/uv) (a fast Python package manager) and convoviz with graphs and word clouds.
+Run one of the commands below to install **everything** you need automatically.
 
-**Linux / macOS:**
+#### 🍎 macOS / 🐧 Linux
+1. Open `Terminal`.
+   - **macOS**: Press `Cmd + Space`, type "Terminal", and hit Enter.
+   - **Linux**: Press `Ctrl + Alt + T`, or search "Terminal" in your app menu.
+2. Copy and paste this command:
 
 ```bash
 curl -fsSL https://raw.githubusercontent.com/mohamed-chs/convoviz/main/install.sh | bash
 ```
 
-**Windows (PowerShell):**
+#### 🪟 Windows
+1. Open `PowerShell`.
+   - Press the `Windows` key, type "PowerShell", and hit Enter.
+2. Copy and paste this command:
 
 ```powershell
 irm https://raw.githubusercontent.com/mohamed-chs/convoviz/main/install.ps1 | iex
 ```
 
-</details>
-
 <details>
 <summary><strong>📦 Alternative: Install with pip</strong></summary>
 
@@ -108,7 +117,7 @@ pip install "convoviz[viz]"
 
 ### Step 3: Run Convoviz
 
-The simplest way is to run the command and follow the interactive prompts:
+The simplest way is to run this in your terminal and follow the interactive prompts:
 
 ```bash
 convoviz
@@ -157,7 +166,7 @@ convoviz --help
 
 ### Step 4: Check the Output 🎉
 
-After running the script, head to your output folder to see:
+After running the script, head to your output folder (defaults to `Documents/ChatGPT-Data` if you didn't change it) to see:
 - 📝 Neatly formatted Markdown files
 - 📊 Visualizations and graphs
 
@@ -177,6 +186,12 @@ And if you've had a great experience, consider giving the project a ⭐ **star**
 
 ---
 
+## 🤝 Contributing
+
+Interested in contributing? Check out the **[Contributing Guide](https://github.com/mohamed-chs/convoviz/tree/main/CONTRIBUTING.md)** for development setup, code style, and how to submit a pull request.
+
+---
+
 ## 📝 Notes
 
 <details>

{convoviz-0.4.2.dist-info → convoviz-0.4.4.dist-info}/RECORD

@@ -36,7 +36,7 @@ convoviz/assets/fonts/YsabeauSC-Regular.ttf,sha256=G4lkq34KKqZOaoomtxFz_KlwVmxg5
 convoviz/assets/fonts/YsabeauSC-Thin.ttf,sha256=hZGOZNTRrxbiUPE2VDeLbtnaRwkMOBaVQbq7Fwx-34c,116932
 convoviz/assets/fonts/Zeyada-Regular.ttf,sha256=fKhkrp9VHt_3Aw8JfkfkPeC2j3CilLWuPUudzBeawPQ,57468
 convoviz/assets/stopwords.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-convoviz/cli.py,sha256=vD4SnS3xthKwNBniWNUy9x1maloBs-xRgcsPHfXzwm4,4888
+convoviz/cli.py,sha256=nniH7QPbbH_buQJGa35vd3IEl7RvZsWRiLpUuhlxXaI,5314
 convoviz/config.py,sha256=qo4JPkJRx1UgvVN_x-XmycxdjU9XwPlqoZWJLsDMSAs,3592
 convoviz/exceptions.py,sha256=bQpIKls48uOQpagEJAxpXf5LF7QoagRRfbD0MjWC7Ak,1476
 convoviz/interactive.py,sha256=Xq55VJJ4OQ9NlY4nlb2NRLzxmA5-ot521N8tGqyPix4,8691
@@ -56,7 +56,7 @@ convoviz/renderers/__init__.py,sha256=IQgwD9NqtUgbS9zwyPBNZbBIZcFrbZ9C7WMAV-X3Xd
 convoviz/renderers/markdown.py,sha256=55PACkd-F0mmBXWXQ5SrfJr3UNrK_z2spQnePdk1UsQ,7849
 convoviz/renderers/yaml.py,sha256=XG1s4VhDdx-TiqekTkgED87RZ1lVQ7IwrbA-sZHrs7k,4056
 convoviz/utils.py,sha256=IQEKYHhWOnYxlr4GwAHoquG0BXTlVRkORL80oUSaIeQ,3417
-convoviz-0.4.2.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
-convoviz-0.4.2.dist-info/entry_points.txt,sha256=HYsmsw5vt36yYHB05uVU48AK2WLkcwshly7m7KKuZMY,54
-convoviz-0.4.2.dist-info/METADATA,sha256=qglS145pZ-nkqxOqWehN4ymFKJtm80rxrQx-OiT292c,7009
-convoviz-0.4.2.dist-info/RECORD,,
+convoviz-0.4.4.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+convoviz-0.4.4.dist-info/entry_points.txt,sha256=HYsmsw5vt36yYHB05uVU48AK2WLkcwshly7m7KKuZMY,54
+convoviz-0.4.4.dist-info/METADATA,sha256=KgUNxmh1vEiTbBYOx82YlFMi-c3d1BKKu3XUUBmHzGY,7803
+convoviz-0.4.4.dist-info/RECORD,,