convoviz 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

convoviz/__init__.py

@@ -1,6 +1,6 @@
 """Convoviz - ChatGPT data visualization and export tool."""
 
-from convoviz import analysis, config, io, models, renderers, utils
+from convoviz import config, io, models, renderers, utils
 from convoviz.config import ConvovizConfig, get_default_config
 from convoviz.models import Conversation, ConversationCollection, Message, Node
 from convoviz.pipeline import run_pipeline
@@ -23,3 +23,12 @@ __all__ = [
     "get_default_config",
     "run_pipeline",
 ]
+
+
+def __getattr__(name: str):
+    """Lazy import for optional submodules like analysis."""
+    if name == "analysis":
+        from convoviz import analysis
+
+        return analysis
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

convoviz/analysis/__init__.py

@@ -1,9 +1,22 @@
-"""Data analysis and visualization for convoviz."""
+"""Data analysis and visualization for convoviz.
 
-from convoviz.analysis.graphs import generate_week_barplot
-from convoviz.analysis.wordcloud import generate_wordcloud
+Requires the [viz] extra: uv tool install "convoviz[viz]"
+"""
 
 __all__ = [
     "generate_week_barplot",
     "generate_wordcloud",
 ]
+
+
+def __getattr__(name: str):
+    """Lazy import for visualization functions requiring optional dependencies."""
+    if name == "generate_week_barplot":
+        from convoviz.analysis.graphs import generate_week_barplot
+
+        return generate_week_barplot
+    if name == "generate_wordcloud":
+        from convoviz.analysis.wordcloud import generate_wordcloud
+
+        return generate_wordcloud
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

convoviz/pipeline.py

@@ -6,7 +6,7 @@ from shutil import rmtree
 from rich.console import Console
 
 from convoviz.config import ConvovizConfig, OutputKind
-from convoviz.exceptions import InvalidZipError
+from convoviz.exceptions import ConfigurationError, InvalidZipError
 from convoviz.io.loaders import (
     find_latest_bookmarklet_json,
     load_collection_from_json,
@@ -122,7 +122,13 @@ def run_pipeline(config: ConvovizConfig) -> None:
     # Generate graphs (if selected)
     if OutputKind.GRAPHS in selected_outputs:
         # Lazy import to allow markdown-only usage without matplotlib
-        from convoviz.analysis.graphs import generate_graphs
+        try:
+            from convoviz.analysis.graphs import generate_graphs
+        except ModuleNotFoundError as e:
+            raise ConfigurationError(
+                "Graph generation requires matplotlib. "
+                'Reinstall with the [viz] extra: uv tool install "convoviz[viz]"'
+            ) from e
 
         graph_folder = output_folder / "Graphs"
         graph_folder.mkdir(parents=True, exist_ok=True)
@@ -140,7 +146,13 @@ def run_pipeline(config: ConvovizConfig) -> None:
     # Generate word clouds (if selected)
     if OutputKind.WORDCLOUDS in selected_outputs:
         # Lazy import to allow markdown-only usage without wordcloud/nltk
-        from convoviz.analysis.wordcloud import generate_wordclouds
+        try:
+            from convoviz.analysis.wordcloud import generate_wordclouds
+        except ModuleNotFoundError as e:
+            raise ConfigurationError(
+                "Word cloud generation requires wordcloud and nltk. "
+                'Reinstall with the [viz] extra: uv tool install "convoviz[viz]"'
+            ) from e
 
         wordcloud_folder = output_folder / "Word-Clouds"
         wordcloud_folder.mkdir(parents=True, exist_ok=True)

{convoviz-0.3.0.dist-info → convoviz-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: convoviz
-Version: 0.3.0
+Version: 0.3.2
 Summary: Get analytics and visualizations on your ChatGPT data!
 Keywords: markdown,chatgpt,openai,visualization,analytics,json,export,data-analysis,obsidian
 Author: Mohamed Cheikh Sidiya
@@ -9,24 +9,23 @@ License-Expression: MIT
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: matplotlib>=3.9.4
-Requires-Dist: nltk>=3.9.2
 Requires-Dist: orjson>=3.11.5
-Requires-Dist: pillow>=11.3.0
 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: wordcloud>=1.9.5
+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/chatgpt-history-export-to-md
+Provides-Extra: viz
 Description-Content-Type: text/markdown
 
 # Convoviz 📊: Visualize your entire ChatGPT data
 
-Convert your ChatGPT history into well-formatted Markdown files. Additionally, visualize your data with word clouds 🔡☁️, view your prompt history graphs 📈, and access all your custom instructions 🤖 in a single location.
+Convert your ChatGPT history into well-formatted Markdown files. Visualize your data with word clouds 🔡☁️ and usage graphs 📈.
 
 ![GitHub last commit](https://img.shields.io/github/last-commit/mohamed-chs/chatgpt-history-export-to-md)
 ![GitHub issues](https://img.shields.io/github/issues/mohamed-chs/chatgpt-history-export-to-md)
@@ -43,29 +42,34 @@ See examples [here](demo).
 
 ### 1. Export Your ChatGPT Data 🗂
 
-- Sign in at [chat.openai.com](https://chat.openai.com).
+- Sign in at [chatgpt.com](https://chatgpt.com).
 - Navigate: Profile Name (bottom left) -> **Settings** -> **Data controls** -> **Export** -> **Confirm export**.
 - Await email from OpenAI and download the `.zip` file.
 
 ### 2. Install the tool 🛠
 
-Try it without installing using uv ([astral-sh/uv](https://github.com/astral-sh/uv?tab=readme-ov-file#highlights)):
+First, install [uv](https://github.com/astral-sh/uv) (if you don't have it):
+
+MacOS / Linux:
 
 ```bash
-uvx convoviz
+curl -LsSf https://astral.sh/uv/install.sh | sh
 ```
 
-You can install it with uv (Recommended):
+Windows (PowerShell):
 
-```bash
-uv tool install convoviz
+```powershell
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
 ```
 
-or pipx:
+Then install convoviz:
+
 ```bash
-pipx install convoviz
+uv tool install "convoviz[viz]"
 ```
 
+The `[viz]` extra includes graphs and word clouds. Skip it for a faster markdown-only install.
+
 ### 3. Run the tool 🏃‍♂️
 
 Simply run the command and follow the prompts:
@@ -82,22 +86,15 @@ You can provide arguments directly to skip the prompts:
 convoviz --input path/to/your/export.zip --output path/to/output/folder
 ```
 
-##### Selective Output Generation
+##### Selective Output
 
-By default, Convoviz generates all outputs (Markdown files, graphs, and word clouds). You can select specific outputs using the `--outputs` flag:
+By default, all outputs are generated. Use `--outputs` to pick specific ones:
 
 ```bash
-# Generate only Markdown files (fastest)
-convoviz --input export.zip --outputs markdown
-
-# Generate Markdown and graphs (no word clouds)
 convoviz --input export.zip --outputs markdown --outputs graphs
-
-# Generate all outputs (default behavior)
-convoviz --input export.zip --outputs markdown --outputs graphs --outputs wordclouds
 ```
 
-In interactive mode, you'll be prompted to select which outputs to generate.
+Options: `markdown`, `graphs`, `wordclouds`. In interactive mode, you'll be prompted.
 
 ##### Other Notes
 
@@ -137,12 +134,12 @@ It should(?) also work as library, so you can import and use the models and func
 
 ### Offline / reproducible runs
 
-Convoviz uses NLTK stopwords for word clouds. If you’re offline and NLTK data isn’t already installed, pre-download it once:
+Word clouds use NLTK stopwords. If you're offline and NLTK data isn't installed yet, pre-download it:
 
 ```bash
-uv run python -c "import nltk; nltk.download('stopwords')"
+python -c "import nltk; nltk.download('stopwords')"
 ```
 
 ### Bookmarklet
 
-There’s also a JavaScript bookmarklet flow under `js/` (experimental) for exporting additional conversation data outside the official ZIP export.
+There's also a JavaScript bookmarklet flow under `js/` (experimental) for exporting additional conversation data outside the official ZIP export.

{convoviz-0.3.0.dist-info → convoviz-0.3.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
-convoviz/__init__.py,sha256=bQLCHO2U9EyMTGqNgsYiCtBQKTKNj4iIM3-TwIkrnRY,612
+convoviz/__init__.py,sha256=UjwkFEmRXhE-3qhsoGTG9XhtoL2cP0o4h3Sp9fcA2Ic,858
 convoviz/__main__.py,sha256=1qiGW13_SgL7wJi8iioIN-AAHGkNGnEl5q_RcPUrI0s,143
-convoviz/analysis/__init__.py,sha256=FxgH5JJpyypiLJpMQn_HlM51jnb8lQdP63_C_W3Dlx4,241
+convoviz/analysis/__init__.py,sha256=1dHjnw88mepSY3Q3U8lEvSqkuWPtkzpyYMgq0CIWoXk,654
 convoviz/analysis/graphs.py,sha256=4uGxVVnbDnBODPlu3g9jZPl6X3JEb4Ri1jXEekhV7-8,29681
 convoviz/analysis/wordcloud.py,sha256=tWQolVTILw40DXLDw6m7O8blDUBRrNG1FqRBA95ISEA,5844
 convoviz/assets/colormaps.txt,sha256=59TSGz428AxY14AEvymAH2IJ2RT9Mlp7Sy0N12NEdXQ,108
@@ -49,13 +49,13 @@ convoviz/models/collection.py,sha256=L658yKMNC6IZrfxYxZBe-oO9COP_bzVfRznnNon7tfU
 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=gO-lLEK8Hme6Sea6soE1idI7sSqrX4W0tgaEFHAJQ_g,5831
+convoviz/pipeline.py,sha256=ClOazQRiOnf4TKogoR1YLam1w7n4k6tznLrEOaB0u8M,6376
 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.3.0.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
-convoviz-0.3.0.dist-info/entry_points.txt,sha256=HYsmsw5vt36yYHB05uVU48AK2WLkcwshly7m7KKuZMY,54
-convoviz-0.3.0.dist-info/METADATA,sha256=pW4mfDwUdNzFFQ-1WAvDRD3L3ySDcSZRgFGWifQrAdw,5238
-convoviz-0.3.0.dist-info/RECORD,,
+convoviz-0.3.2.dist-info/WHEEL,sha256=XV0cjMrO7zXhVAIyyc8aFf1VjZ33Fen4IiJk5zFlC3g,80
+convoviz-0.3.2.dist-info/entry_points.txt,sha256=HYsmsw5vt36yYHB05uVU48AK2WLkcwshly7m7KKuZMY,54
+convoviz-0.3.2.dist-info/METADATA,sha256=tU6PUYA9oaH9stGsmhq404ba7uWbD8-mJJ0s_dYERMs,4930
+convoviz-0.3.2.dist-info/RECORD,,