convoviz 0.4.3__tar.gz → 0.4.5__tar.gz

{convoviz-0.4.3 → convoviz-0.4.5}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: convoviz
-Version: 0.4.3
-Summary: Get analytics and visualizations on your ChatGPT data!
+Version: 0.4.5
+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>
@@ -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
 
@@ -185,6 +194,19 @@ Interested in contributing? Check out the **[Contributing Guide](https://github.
 
 ## 📝 Notes
 
+<details>
+<summary><strong>Offline</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')"
+```
+
+**NOTE:** The install script already handles this, so you can immediately go offline after running it.
+
+</details>
+
 <details>
 <summary><strong>About This Project</strong></summary>
 
@@ -203,17 +225,6 @@ It should also work as a library, so you can import and use the models and funct
 
 </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>
 

{convoviz-0.4.3 → convoviz-0.4.5}/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>
@@ -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
 
@@ -160,6 +169,19 @@ Interested in contributing? Check out the **[Contributing Guide](https://github.
 
 ## 📝 Notes
 
+<details>
+<summary><strong>Offline</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')"
+```
+
+**NOTE:** The install script already handles this, so you can immediately go offline after running it.
+
+</details>
+
 <details>
 <summary><strong>About This Project</strong></summary>
 
@@ -178,17 +200,6 @@ It should also work as a library, so you can import and use the models and funct
 
 </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>
 

{convoviz-0.4.3 → convoviz-0.4.5}/convoviz/interactive.py

@@ -92,7 +92,7 @@ def run_interactive_config(initial_config: ConvovizConfig | None = None) -> Conv
     input_default = str(config.input_path) if config.input_path else ""
     input_result: str = _ask_or_cancel(
         qst_path(
-            "Enter the path to the export ZIP, conversations JSON, or extracted directory:",
+            "Enter the path to the export ZIP:",  # , conversations JSON, or extracted directory:",
             default=input_default,
             validate=_validate_input_path,
             style=CUSTOM_STYLE,

convoviz-0.4.5/pyproject.toml

@@ -0,0 +1,118 @@
+[project]
+name = "convoviz"
+version = "0.4.5"
+description = "Convert your ChatGPT export (ZIP) into clean Markdown text files with inline media, and generate data visualizations like word clouds and usage graphs."
+readme = "README.md"
+requires-python = ">=3.12"
+authors = [
+  { name = "Mohamed Cheikh Sidiya", email = "mohamedcheikhsidiya77@gmail.com" },
+]
+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",
+]
+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.urls]
+Repository = "https://github.com/mohamed-chs/convoviz"
+
+[project.optional-dependencies]
+viz = ["nltk>=3.9.2", "wordcloud>=1.9.5"]
+
+[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",
+  "poethepoet>=0.40.0",
+]
+
+# run with 'uv run poe <task>' eg. 'uv run poe fmt'
+# or if poe is installed globally, 'poe fmt'
+[tool.poe.tasks]
+lint = "ruff check --fix convoviz tests"
+fmt = "ruff format"
+test = "pytest"
+ty = "ty check convoviz"
+
+[project.scripts]
+convoviz = "convoviz.cli:main_entry"
+
+[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 = ["."]
+
+[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",
+]

convoviz-0.4.3/pyproject.toml

@@ -1,105 +0,0 @@
-[project]
-name = "convoviz"
-version = "0.4.3"
-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 = ["."]