convoviz 0.4.2__tar.gz → 0.4.4__tar.gz

{convoviz-0.4.2 → convoviz-0.4.4}/PKG-INFO

@@ -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 → convoviz-0.4.4}/README.md

@@ -2,7 +2,12 @@
   <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>
@@ -10,7 +15,7 @@
 <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>
 
@@ -25,7 +30,7 @@
 | ☁️ **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!**
 
 ---
 
@@ -42,25 +47,29 @@
 
 ### 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>
 
@@ -83,7 +92,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
@@ -132,7 +141,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
 
@@ -152,6 +161,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 → convoviz-0.4.4}/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.4/pyproject.toml

@@ -0,0 +1,109 @@
+[project]
+name = "convoviz"
+version = "0.4.4"
+description = "Convert your ChatGPT export (ZIP) into clean Markdown text files with inline media, and generate data visualizations like word clouds and usage graphs."
+license = "MIT"
+keywords = [
+  "markdown",
+  "chatgpt",
+  "openai",
+  "visualization",
+  "analytics",
+  "json",
+  "export",
+  "data-analysis",
+  "obsidian",
+]
+classifiers = [
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+]
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [
+  { name = "Mohamed Cheikh Sidiya", email = "mohamedcheikhsidiya77@gmail.com" },
+]
+dependencies = [
+  "orjson>=3.11.5",
+  "pydantic>=2.12.5",
+  "pydantic-settings>=2.7.0",
+  "questionary>=2.1.1",
+  "rich>=14.2.0",
+  "tqdm>=4.67.1",
+  "typer>=0.21.0",
+]
+
+[project.optional-dependencies]
+viz = ["nltk>=3.9.2", "wordcloud>=1.9.5"]
+
+[project.urls]
+Repository = "https://github.com/mohamed-chs/convoviz"
+
+[build-system]
+requires = ["uv_build"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+# Add this line to tell uv your code is in the root, not in src/
+module-root = "."
+
+# Files to exclude from the Source Distribution (sdist)
+source-exclude = [
+  ".github",
+  ".vscode",
+  ".gitattributes",
+  ".gitignore",
+  "dev",
+  "playground.ipynb",
+  "pyproject.toml.bak",
+  "uv.lock",
+  "demo",
+  "js",
+  "tests",
+]
+
+[project.scripts]
+convoviz = "convoviz.cli:main_entry"
+
+[dependency-groups]
+dev = [
+  "pytest>=8.4.2",
+  "ruff>=0.14.10",
+  "ty>=0.0.11",
+  "types-tqdm>=4.67.0.20250809",
+  # Viz extras for testing (wordcloud pulls in matplotlib + pillow)
+  "nltk>=3.9.2",
+  "wordcloud>=1.9.5",
+]
+
+[tool.ruff]
+target-version = "py312"
+line-length = 100
+
+[tool.ruff.lint]
+select = [
+  "E",   # pycodestyle errors
+  "W",   # pycodestyle warnings
+  "F",   # Pyflakes
+  "I",   # isort
+  "B",   # flake8-bugbear
+  "C4",  # flake8-comprehensions
+  "UP",  # pyupgrade
+  "ARG", # flake8-unused-arguments
+  "SIM", # flake8-simplify
+]
+ignore = [
+  "E501", # line too long (handled by formatter)
+  "B008", # do not perform function calls in argument defaults
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["convoviz"]
+
+[tool.ty.environment]
+python-version = "3.12"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["."]

convoviz-0.4.2/pyproject.toml

@@ -1,105 +0,0 @@
-[project]
-name = "convoviz"
-version = "0.4.2"
-description = "Get analytics and visualizations on your ChatGPT data!"
-license = "MIT"
-keywords = [
-    "markdown", "chatgpt", "openai", "visualization",
-    "analytics", "json", "export", "data-analysis", "obsidian"
-]
-classifiers = [
-    "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.12",
-]
-readme = "README.md"
-requires-python = ">=3.12"
-authors = [
-    { name = "Mohamed Cheikh Sidiya", email = "mohamedcheikhsidiya77@gmail.com" }
-]
-dependencies = [
-    "orjson>=3.11.5",
-    "pydantic>=2.12.5",
-    "pydantic-settings>=2.7.0",
-    "questionary>=2.1.1",
-    "rich>=14.2.0",
-    "tqdm>=4.67.1",
-    "typer>=0.21.0",
-]
-
-[project.optional-dependencies]
-viz = [
-    "nltk>=3.9.2",
-    "wordcloud>=1.9.5",
-]
-
-[project.urls]
-Repository = "https://github.com/mohamed-chs/convoviz"
-
-[build-system]
-requires = ["uv_build"]
-build-backend = "uv_build"
-
-[tool.uv.build-backend]
-# Add this line to tell uv your code is in the root, not in src/
-module-root = "."
-
-# Files to exclude from the Source Distribution (sdist)
-source-exclude = [
-    ".github",
-    ".vscode",
-    ".gitattributes",
-    ".gitignore",
-    "dev",
-    "playground.ipynb",
-    "pyproject.toml.bak",
-    "uv.lock",
-    "demo",
-    "js",
-    "tests",
-]
-
-[project.scripts]
-convoviz = "convoviz.cli:main_entry"
-
-[dependency-groups]
-dev = [
-    "pytest>=8.4.2",
-    "ruff>=0.14.10",
-    "ty>=0.0.11",
-    "types-tqdm>=4.67.0.20250809",
-    # Viz extras for testing (wordcloud pulls in matplotlib + pillow)
-    "nltk>=3.9.2",
-    "wordcloud>=1.9.5",
-]
-
-[tool.ruff]
-target-version = "py312"
-line-length = 100
-
-[tool.ruff.lint]
-select = [
-    "E",      # pycodestyle errors
-    "W",      # pycodestyle warnings
-    "F",      # Pyflakes
-    "I",      # isort
-    "B",      # flake8-bugbear
-    "C4",     # flake8-comprehensions
-    "UP",     # pyupgrade
-    "ARG",    # flake8-unused-arguments
-    "SIM",    # flake8-simplify
-]
-ignore = [
-    "E501",   # line too long (handled by formatter)
-    "B008",   # do not perform function calls in argument defaults
-]
-
-[tool.ruff.lint.isort]
-known-first-party = ["convoviz"]
-
-[tool.ty.environment]
-python-version = "3.12"
-
-[tool.pytest.ini_options]
-testpaths = ["tests"]
-pythonpath = ["."]