convoviz


Nameconvoviz JSON
Version 0.1.6 PyPI version JSON
download
home_pagehttps://github.com/mohamed-chs/chatgpt-history-export-to-md
SummaryGet analytics and visualizations on your ChatGPT data !
upload_time2023-11-06 15:28:54
maintainer
docs_urlNone
authorMohamed Cheikh Sidiya
requires_python>=3.9,<4.0
licenseMIT
keywords markdown advanced-data-analysis json zip openai chatgpt bookmarklet obsidian-md code-interpreter
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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.

![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)

## Features

- **YAML Headers**: Optional and included by default.
- **Track message versions**: prompt/response edits included.
- **Code Interpreter**: Environment code blocks and execution results.
- **Data Visualizations**: Word clouds, graphs, and more.
- **Custom Instructions**: All your custom instructions in one JSON file.

See examples [here](demo).

## How to Use ๐Ÿ“–

### 1. Export Your ChatGPT Data ๐Ÿ—‚

- Sign in at [chat.openai.com](https://chat.openai.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 ๐Ÿ› 

Open a terminal or command prompt and run:

```bash
pip install convoviz
```

to install the package.

### 3. Run the Script ๐Ÿƒโ€โ™‚๏ธ

With the package installed, run the following command in your terminal:

```bash
python -m convoviz
```

Next, follow the instructions displayed and choose your desired options, the script will handle the rest.

### 4. Check the Output ๐ŸŽ‰

And that's it! After running the script, head over to the output folder to see your nice word clouds, graphs, and neatly formatted Markdown files. Enjoy !

**Tweet Your Discoveries**:

[![Tweet](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fyourusername%2Fyourrepository)](https://twitter.com/intent/tweet?text=So%2C%20this%20is%20what%20my%20entire%20ChatGPT%20history%20looks%20like%20...%0D%0A%0D%0Ahttp%3A%2F%2Fbit.ly%2F3ZuHCCK)

### How to add new conversations โž•

See [How to use the JS script](js/how_to_use.md) for instructions on how to download new conversations.

## 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 (especially if 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!

**Here's how you can share your thoughts:**

1. **GitHub Issues**: For more specific feedback or if you've stumbled upon a bug, please open an [issue](https://github.com/mohamed-chs/chatgpt-history-export-to-md/issues). This helps me track and address them effectively.

2. **GitHub Discussions**: If you just want to share your general experience, have a suggestion, or maybe a cool idea for a new feature, jump into the [discussions](https://github.com/mohamed-chs/chatgpt-history-export-to-md/discussions) page. It's a more casual space where we can chat.

And if you've had a great experience, consider giving the project a star โญ. It keeps me motivated and helps others discover it!

Thank you for being awesome! ๐ŸŒŸ

## Notes

This project requires Python 3.8.7 or higher if on Windows. See [known issue](https://github.com/prompt-toolkit/python-prompt-toolkit/issues/1023#issue-534396318)

This is just a small thing I coded to help me see my convos in beautiful markdown, in [Obsidian](https://obsidian.md/) (my go-to note-taking app).

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.

It also works as package, so you can **import** it in your own projects, and use the models and functions as you wish. I need to add more documentation for that tho. Feel free to reach out if you need help.

I'm working on automating it to add new conversations and updating old ones. Had some luck with a JavaScript bookmarklet, still ironing it out tho. Shouldn't take long.

> for an older version with zero dependencies, see https://github.com/mohamed-chs/chatgpt-history-export-to-md/tree/fe13a701fe8653c9f946b1e12979ce3bfe7104b8.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mohamed-chs/chatgpt-history-export-to-md",
    "name": "convoviz",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "markdown,advanced-data-analysis,json,zip,openai,chatgpt,bookmarklet,obsidian-md,code-interpreter",
    "author": "Mohamed Cheikh Sidiya",
    "author_email": "mohamedcheikhsidiya77@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/eb/e3/5ea04a0a12d1e69b4c5bc07f3c693bff46de480cad6cb6fa15f189308df3/convoviz-0.1.6.tar.gz",
    "platform": null,
    "description": "# Convoviz \ud83d\udcca: Visualize your entire ChatGPT data !\n\nConvert your ChatGPT history into well-formatted Markdown files. Additionally, visualize your data with word clouds \ud83d\udd21\u2601\ufe0f, view your prompt history graphs \ud83d\udcc8, and access all your custom instructions \ud83e\udd16 in a single location.\n\n![GitHub last commit](https://img.shields.io/github/last-commit/mohamed-chs/chatgpt-history-export-to-md)\n![GitHub issues](https://img.shields.io/github/issues/mohamed-chs/chatgpt-history-export-to-md)\n\n## Features\n\n- **YAML Headers**: Optional and included by default.\n- **Track message versions**: prompt/response edits included.\n- **Code Interpreter**: Environment code blocks and execution results.\n- **Data Visualizations**: Word clouds, graphs, and more.\n- **Custom Instructions**: All your custom instructions in one JSON file.\n\nSee examples [here](demo).\n\n## How to Use \ud83d\udcd6\n\n### 1. Export Your ChatGPT Data \ud83d\uddc2\n\n- Sign in at [chat.openai.com](https://chat.openai.com).\n- Navigate: Profile Name (bottom left) -> **Settings** -> **Data controls** -> **Export** -> **Confirm export**.\n- Await email from OpenAI and download the `.zip` file.\n\n### 2. Install the tool \ud83d\udee0\n\nOpen a terminal or command prompt and run:\n\n```bash\npip install convoviz\n```\n\nto install the package.\n\n### 3. Run the Script \ud83c\udfc3\u200d\u2642\ufe0f\n\nWith the package installed, run the following command in your terminal:\n\n```bash\npython -m convoviz\n```\n\nNext, follow the instructions displayed and choose your desired options, the script will handle the rest.\n\n### 4. Check the Output \ud83c\udf89\n\nAnd that's it! After running the script, head over to the output folder to see your nice word clouds, graphs, and neatly formatted Markdown files. Enjoy !\n\n**Tweet Your Discoveries**:\n\n[![Tweet](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fyourusername%2Fyourrepository)](https://twitter.com/intent/tweet?text=So%2C%20this%20is%20what%20my%20entire%20ChatGPT%20history%20looks%20like%20...%0D%0A%0D%0Ahttp%3A%2F%2Fbit.ly%2F3ZuHCCK)\n\n### How to add new conversations \u2795\n\nSee [How to use the JS script](js/how_to_use.md) for instructions on how to download new conversations.\n\n## Share Your Feedback! \ud83d\udc8c\n\nI hope you find this tool useful. I'm continuously looking to improve on this, but I need your help for that.\n\nWhether you're a tech wizard or you're new to all this (especially if 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!\n\n**Here's how you can share your thoughts:**\n\n1. **GitHub Issues**: For more specific feedback or if you've stumbled upon a bug, please open an [issue](https://github.com/mohamed-chs/chatgpt-history-export-to-md/issues). This helps me track and address them effectively.\n\n2. **GitHub Discussions**: If you just want to share your general experience, have a suggestion, or maybe a cool idea for a new feature, jump into the [discussions](https://github.com/mohamed-chs/chatgpt-history-export-to-md/discussions) page. It's a more casual space where we can chat.\n\nAnd if you've had a great experience, consider giving the project a star \u2b50. It keeps me motivated and helps others discover it!\n\nThank you for being awesome! \ud83c\udf1f\n\n## Notes\n\nThis project requires Python 3.8.7 or higher if on Windows. See [known issue](https://github.com/prompt-toolkit/python-prompt-toolkit/issues/1023#issue-534396318)\n\nThis is just a small thing I coded to help me see my convos in beautiful markdown, in [Obsidian](https://obsidian.md/) (my go-to note-taking app).\n\nI wasn't a fan of the clunky, and sometimes paid, browser extensions.\n\nIt 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.\n\nIt also works as package, so you can **import** it in your own projects, and use the models and functions as you wish. I need to add more documentation for that tho. Feel free to reach out if you need help.\n\nI'm working on automating it to add new conversations and updating old ones. Had some luck with a JavaScript bookmarklet, still ironing it out tho. Shouldn't take long.\n\n> for an older version with zero dependencies, see https://github.com/mohamed-chs/chatgpt-history-export-to-md/tree/fe13a701fe8653c9f946b1e12979ce3bfe7104b8.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Get analytics and visualizations on your ChatGPT data !",
    "version": "0.1.6",
    "project_urls": {
        "Homepage": "https://github.com/mohamed-chs/chatgpt-history-export-to-md",
        "Repository": "https://github.com/mohamed-chs/chatgpt-history-export-to-md"
    },
    "split_keywords": [
        "markdown",
        "advanced-data-analysis",
        "json",
        "zip",
        "openai",
        "chatgpt",
        "bookmarklet",
        "obsidian-md",
        "code-interpreter"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "43f45363cbcaa8f5a05e7209cda8e205469801bd643dfbe3b076d5ecc9e56e92",
                "md5": "5d171426f009f9744d7c6497b104ff8d",
                "sha256": "9e9e87f9d2313e02aa9699023f1c4ef73a9889f7ece13e0e325e8a811af8cb02"
            },
            "downloads": -1,
            "filename": "convoviz-0.1.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5d171426f009f9744d7c6497b104ff8d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 1922889,
            "upload_time": "2023-11-06T15:28:46",
            "upload_time_iso_8601": "2023-11-06T15:28:46.094390Z",
            "url": "https://files.pythonhosted.org/packages/43/f4/5363cbcaa8f5a05e7209cda8e205469801bd643dfbe3b076d5ecc9e56e92/convoviz-0.1.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ebe35ea04a0a12d1e69b4c5bc07f3c693bff46de480cad6cb6fa15f189308df3",
                "md5": "42fac415174ea67c5294f76b0062b94d",
                "sha256": "2ee8de38a09b844f6f0c4720467df33d8dc566f1b7ba60908131ff211b603dc4"
            },
            "downloads": -1,
            "filename": "convoviz-0.1.6.tar.gz",
            "has_sig": false,
            "md5_digest": "42fac415174ea67c5294f76b0062b94d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 1916927,
            "upload_time": "2023-11-06T15:28:54",
            "upload_time_iso_8601": "2023-11-06T15:28:54.267952Z",
            "url": "https://files.pythonhosted.org/packages/eb/e3/5ea04a0a12d1e69b4c5bc07f3c693bff46de480cad6cb6fa15f189308df3/convoviz-0.1.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-06 15:28:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mohamed-chs",
    "github_project": "chatgpt-history-export-to-md",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "convoviz"
}
        
Elapsed time: 0.95508s