convoviz 0.4.1__py3-none-any.whl

convoviz-0.4.1.dist-info/METADATA

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: convoviz
+Version: 0.4.1
+Summary: Get analytics and visualizations on your ChatGPT data!
+Keywords: markdown,chatgpt,openai,visualization,analytics,json,export,data-analysis,obsidian
+Author: Mohamed Cheikh Sidiya
+Author-email: Mohamed Cheikh Sidiya <mohamedcheikhsidiya77@gmail.com>
+License-Expression: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: orjson>=3.11.5
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pydantic-settings>=2.7.0
+Requires-Dist: questionary>=2.1.1
+Requires-Dist: rich>=14.2.0
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: typer>=0.21.0
+Requires-Dist: nltk>=3.9.2 ; extra == 'viz'
+Requires-Dist: wordcloud>=1.9.5 ; extra == 'viz'
+Requires-Python: >=3.12
+Project-URL: Repository, https://github.com/mohamed-chs/convoviz
+Provides-Extra: viz
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <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>
+    Visualize your data with word clouds 🔡☁️ and usage graphs 📈.
+  </p>
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/convoviz/"><img src="https://img.shields.io/pypi/v/convoviz?style=flat-square&logo=pypi&logoColor=white&label=PyPI" alt="PyPI Version"></a>
+  <a href="https://pepy.tech/projects/convoviz"><img src="https://static.pepy.tech/personalized-badge/convoviz?period=total&units=INTERNATIONAL_SYSTEM&left_color=GREY&right_color=GREEN&left_text=Downloads" alt="PyPI Downloads"></a>
+  <a href="https://github.com/mohamed-chs/convoviz/blob/main/LICENSE"><img src="https://img.shields.io/github/license/mohamed-chs/convoviz?style=flat-square" alt="License"></a>
+</p>
+
+---
+
+## ✨ Features
+
+| Feature | Description |
+|---------|-------------|
+| 📝 **Markdown Export** | Clean, well-formatted Markdown with optional YAML headers |
+| 🖼️ **Inline Images** | Media attachments rendered directly in your Markdown files |
+| ☁️ **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!**
+
+---
+
+## 📖 How to Use
+
+### Step 1: Export Your ChatGPT Data
+
+1. Sign in at [chatgpt.com](https://chatgpt.com)
+2. Navigate to: **Profile Name** (bottom left) → **Settings** → **Data controls** → **Export**
+3. Click **Confirm export**
+4. Wait for the email from OpenAI, then download the `.zip` file
+
+---
+
+### Step 2: Install Convoviz
+
+<details open>
+<summary><strong>🚀 Quick Install (Recommended)</strong></summary>
+
+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.
+
+**Linux / macOS:**
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/mohamed-chs/convoviz/main/install.sh | bash
+```
+
+**Windows (PowerShell):**
+
+```powershell
+irm https://raw.githubusercontent.com/mohamed-chs/convoviz/main/install.ps1 | iex
+```
+
+</details>
+
+<details>
+<summary><strong>📦 Alternative: Install with pip</strong></summary>
+
+If you prefer using `pip` directly:
+
+```bash
+# Create a virtual environment (keeps your system Python clean)
+python3 -m venv .venv
+
+# Activate the virtual environment
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+
+# Install convoviz with visualization extras
+pip install "convoviz[viz]"
+```
+
+</details>
+
+---
+
+### Step 3: Run Convoviz
+
+The simplest way is to run the command and follow the interactive prompts:
+
+```bash
+convoviz
+```
+
+Or, provide arguments directly to skip the prompts:
+
+```bash
+convoviz --input path/to/your/export.zip --output path/to/output/folder
+```
+
+<details>
+<summary><strong>⚙️ Command Line Options</strong></summary>
+
+#### Selective Output
+
+By default, all outputs (Markdown, graphs, word clouds) are generated. Use `--outputs` to pick specific ones:
+
+```bash
+convoviz --input export.zip --outputs markdown --outputs graphs
+```
+
+Available options: `markdown`, `graphs`, `wordclouds`
+
+> In interactive mode, you'll be prompted to choose which outputs to generate.
+
+#### Other Useful Flags
+
+| Flag | Description |
+|------|-------------|
+| `--zip` / `-z` | Alias for `--input` (for convenience) |
+| `--no-interactive` | Force non-interactive mode |
+| `--flat` | Put all Markdown files in a single folder (instead of organizing by date) |
+| `--verbose` / `-v` | Enable detailed logging (use `-vv` for debug logs) |
+| `--log-file PATH` | Specify a custom log file location |
+
+For a complete list of options:
+
+```bash
+convoviz --help
+```
+
+</details>
+
+---
+
+### Step 4: Check the Output 🎉
+
+After running the script, head to your output folder to see:
+- 📝 Neatly formatted Markdown files
+- 📊 Visualizations and graphs
+
+![wordcloud example](demo/wordcloud-example.png)
+
+---
+
+## 💌 Share Your Feedback!
+
+I hope you find this tool useful. I'm continuously looking to improve on this, but I need your help for that.
+
+Whether you're a tech wizard or you're new to all this, I'd love to hear about your journey with the tool. Found a quirk? Have a suggestion? Or just want to send some good vibes? I'm all ears!
+
+👉 **[Open an Issue](https://github.com/mohamed-chs/convoviz/issues)**
+
+And if you've had a great experience, consider giving the project a ⭐ **star**! It keeps me motivated and helps others discover it!
+
+---
+
+## 📝 Notes
+
+<details>
+<summary><strong>About This Project</strong></summary>
+
+This is just a small thing I coded to help me see my convos in beautiful markdown. It was originally built with [Obsidian](https://obsidian.md/) (my go-to note-taking app) in mind, but the default output is standard Markdown.
+
+I wasn't a fan of the clunky, and sometimes paid, browser extensions.
+
+It was also a great opportunity to learn more about Python and type annotations. I had mypy, pyright, and ruff all on strict mode, 'twas fun.
+
+</details>
+
+<details>
+<summary><strong>Using as a Library</strong></summary>
+
+It should also work as a library, so you can import and use the models and functions. I need to add more documentation for that though. Feel free to reach out if you need help.
+
+</details>
+
+<details>
+<summary><strong>Offline / Reproducible Runs</strong></summary>
+
+Word clouds use NLTK stopwords. If you're offline and NLTK data isn't installed yet, pre-download it:
+
+```bash
+python -c "import nltk; nltk.download('stopwords')"
+```
+
+</details>
+
+<details>
+<summary><strong>Bookmarklet (Experimental)</strong></summary>
+
+There's also a JavaScript bookmarklet flow under `js/` for exporting additional conversation data outside the official ZIP export. This is experimental.
+
+</details>

convoviz-0.4.1.dist-info/RECORD

@@ -0,0 +1,62 @@
+convoviz/__init__.py,sha256=UjwkFEmRXhE-3qhsoGTG9XhtoL2cP0o4h3Sp9fcA2Ic,858
+convoviz/__main__.py,sha256=1qiGW13_SgL7wJi8iioIN-AAHGkNGnEl5q_RcPUrI0s,143
+convoviz/analysis/__init__.py,sha256=1dHjnw88mepSY3Q3U8lEvSqkuWPtkzpyYMgq0CIWoXk,654
+convoviz/analysis/graphs.py,sha256=OGLkyKx9Fq7r4jK-A46oy1NWttQ5F2MLxO4mfW6wkfc,29796
+convoviz/analysis/wordcloud.py,sha256=3MfBg_Aq7-nz0Zc-FhkxEvTljImIQU0rmXZv81WUBDM,6178
+convoviz/assets/colormaps.txt,sha256=59TSGz428AxY14AEvymAH2IJ2RT9Mlp7Sy0N12NEdXQ,108
+convoviz/assets/fonts/AmaticSC-Regular.ttf,sha256=83clh7a3urnTLud0_yZofuIb6BdyC2LMI9jhE6G2LvU,142696
+convoviz/assets/fonts/ArchitectsDaughter-Regular.ttf,sha256=fnrj5_N_SlY2Lj3Ehqz5aKECPZVJlJAflgsOU94_qIM,37756
+convoviz/assets/fonts/BebasNeue-Regular.ttf,sha256=gw6hhqz_wjFu0aTkIxkka6O0awTjOiEQeSSb-QEZPwQ,57676
+convoviz/assets/fonts/Borel-Regular.ttf,sha256=6E7H87Enm1-QuDy6CuLXw41IbOh2btYvljdfsAkeeu4,132820
+convoviz/assets/fonts/Courgette-Regular.ttf,sha256=kUua74ktTfKWAKu-0oVRipQJA8nlchHWqq-OGq7JG_M,118784
+convoviz/assets/fonts/CroissantOne-Regular.ttf,sha256=gc0c94cU793bsKEIWEuD7voDOhsqNZZEi55GH22WTXc,50376
+convoviz/assets/fonts/Handjet-Regular.ttf,sha256=VLCiudWwT2HdrZ3y8gFKwzKOhggvMyFh5TwAkj6HOvQ,216176
+convoviz/assets/fonts/IndieFlower-Regular.ttf,sha256=5qE5ITuqVLL_UdMA-YzBwW1pC1BGpLDkJDXL95F2eFM,55416
+convoviz/assets/fonts/Kalam-Regular.ttf,sha256=wqWCLjW9mCZzW6-M6lSVNP0wDJeRKSmdMnoVXtnvZn8,427336
+convoviz/assets/fonts/Lobster-Regular.ttf,sha256=zd13efsueDgqZU-R3VplYhjPEzokThei9dlgwG-V1zw,396740
+convoviz/assets/fonts/MartianMono-Regular.ttf,sha256=oJFu0DsDo4eU_H9yeD8ww9X10to42tFnPU5Edpr6YQo,47676
+convoviz/assets/fonts/MartianMono-Thin.ttf,sha256=P1wEdv9k7TzEovrny8EWhOx4nGHJQJDZGjNNEHh_5zA,47628
+convoviz/assets/fonts/Montserrat-Regular.ttf,sha256=w_sCgOQzn2xwzqQri0Msb7F_3hMPuxLpIJx836edl28,197624
+convoviz/assets/fonts/Mooli-Regular.ttf,sha256=P_eRzLpcOE1_WIrPfwhZc33CjVdf0_G2w1ze8emgke8,61728
+convoviz/assets/fonts/Pacifico-Regular.ttf,sha256=Tayds_qcoHL3hh_ZFr8Evc6sYGnQ86iG9eUj2SLpGPE,315408
+convoviz/assets/fonts/PlayfairDisplay-Regular.ttf,sha256=vW5BYONJ5AxF9LDsYAh6niMxohsqxfuQEU2AxiNlvGM,193384
+convoviz/assets/fonts/Raleway-Regular.ttf,sha256=kx43oi40dzqQs-j0aYjwKRQDk-vNN-IANUQSKzyQkaQ,164120
+convoviz/assets/fonts/RobotoMono-Regular.ttf,sha256=jZofpN_lpd7qeA9lE5lhQUJe94LXzFZl1NRZFG_Tpxw,87236
+convoviz/assets/fonts/RobotoMono-Thin.ttf,sha256=KlSVbRQa_5s8wCGOiHAIYPD8AEZ1g5YxxhwRCKHdww0,88288
+convoviz/assets/fonts/RobotoSlab-Regular.ttf,sha256=kZ83pmV8RegwHpAfR3NwDMbUEyNu2kT8b8X_MrpSh7k,126524
+convoviz/assets/fonts/RobotoSlab-Thin.ttf,sha256=SZBfAfOfqwr1KB8OcVEex7yQtCev-8Cie5EvsD9Io_4,125724
+convoviz/assets/fonts/Ruwudu-Regular.ttf,sha256=HpZ1038Ff7kG2bApUnRZBBG1FjOeoAOCJMo9unCVowY,119044
+convoviz/assets/fonts/Sacramento-Regular.ttf,sha256=pbneZ75FSoJrRthYUS4y7sjDAxK-tMT4ZK7iOQQU6cU,64808
+convoviz/assets/fonts/SedgwickAveDisplay-Regular.ttf,sha256=61N9i9C97qTfkA7gcTey4f5ZRhkvsaZHfTt24juT9k0,135996
+convoviz/assets/fonts/ShadowsIntoLight-Regular.ttf,sha256=LWlyCLEzqQCrH1YH5DfQObGaD5Vvw9mYdgyrs8Ea07A,48468
+convoviz/assets/fonts/TitilliumWeb-Regular.ttf,sha256=SG54vnynWWN2QYtRIEQ-4aNZ6VSI2hf3qIKC2C801Rw,57392
+convoviz/assets/fonts/Yellowtail-Regular.ttf,sha256=AUGAkQQeDnNSWxhBbj-dudY75_nARDwWRldDvzqdtIs,60864
+convoviz/assets/fonts/YsabeauOffice-Regular.ttf,sha256=RnW2erC5p6s2YxvWmwa019hYTzhynkcu9M_X-KrPhjY,204200
+convoviz/assets/fonts/YsabeauSC-Regular.ttf,sha256=G4lkq34KKqZOaoomtxFz_KlwVmxg56UbFXFnWgijkDM,116980
+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/config.py,sha256=qo4JPkJRx1UgvVN_x-XmycxdjU9XwPlqoZWJLsDMSAs,3592
+convoviz/exceptions.py,sha256=bQpIKls48uOQpagEJAxpXf5LF7QoagRRfbD0MjWC7Ak,1476
+convoviz/interactive.py,sha256=Xq55VJJ4OQ9NlY4nlb2NRLzxmA5-ot521N8tGqyPix4,8691
+convoviz/io/__init__.py,sha256=y70TYypJ36_kaEA04E2wa1EDaKQVjprKItoKR6MMs4M,471
+convoviz/io/assets.py,sha256=5zcZPlQa9niDw9o-sqJIKgLc0OJ9auzd6KAve5WfBkQ,3459
+convoviz/io/loaders.py,sha256=SqmBWUBqT5lsCf01yy-FUhwIxbiKTFMQnj4k213DsGI,5891
+convoviz/io/writers.py,sha256=-HTvj7D9sqM8M-RsGwd44AquxCVmcDVHgta22QlfNzU,7068
+convoviz/logging_config.py,sha256=PRuOKij8UD6sKdg3lAsu9lUsTUZ3O6_6uffnyg07M1U,2060
+convoviz/models/__init__.py,sha256=6gAfrk6KJT2QxdvX_v15mUdfIqEw1xKxwQlKSfyA5eI,532
+convoviz/models/collection.py,sha256=L658yKMNC6IZrfxYxZBe-oO9COP_bzVfRznnNon7tfU,4467
+convoviz/models/conversation.py,sha256=ssx1Z6LM9kJIx3OucQW8JVoAc8zCdxj1iOLtie2B3ak,5678
+convoviz/models/message.py,sha256=0CJ9hJ1rQiesn1SgHqFgEgKUgS7XAPGtSunQl5q8Pl4,8316
+convoviz/models/node.py,sha256=1vBAtKVscYsUBDnKAOyLxuZaK9KoVF1dFXiKXRHxUnY,1946
+convoviz/pipeline.py,sha256=1kLtsNDN3LYNudyPBlyKwQZ8zWCmRKveP3VWfIgichw,6765
+convoviz/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+convoviz/renderers/__init__.py,sha256=IQgwD9NqtUgbS9zwyPBNZbBIZcFrbZ9C7WMAV-X3Xdg,261
+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.1.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+convoviz-0.4.1.dist-info/entry_points.txt,sha256=HYsmsw5vt36yYHB05uVU48AK2WLkcwshly7m7KKuZMY,54
+convoviz-0.4.1.dist-info/METADATA,sha256=tTfEvauoNtlXktgYd9I9M_N7MGSWdjBF5pVRnBwWZlI,6834
+convoviz-0.4.1.dist-info/RECORD,,

convoviz-0.4.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.28
+Root-Is-Purelib: true
+Tag: py3-none-any

convoviz-0.4.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+convoviz = convoviz.cli:main_entry
+