Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mlomb/chat-analytics

Generate interactive, beautiful and insightful chat analysis reports
https://github.com/mlomb/chat-analytics

analysis analytics analyzer app chat chat-analysis chat-analyzer cli data-visualization discord telegram whatsapp

Last synced: 26 days ago
JSON representation

Generate interactive, beautiful and insightful chat analysis reports

Host: GitHub
URL: https://github.com/mlomb/chat-analytics
Owner: mlomb
License: agpl-3.0
Created: 2021-07-26T00:41:27.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-08-14T22:48:03.000Z (3 months ago)
Last Synced: 2024-10-01T00:23:33.987Z (about 1 month ago)
Topics: analysis, analytics, analyzer, app, chat, chat-analysis, chat-analyzer, cli, data-visualization, discord, telegram, whatsapp
Language: TypeScript
Homepage: https://chatanalytics.app
Size: 14 MB
Stars: 659
Watchers: 8
Forks: 48
Open Issues: 21
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome - mlomb/chat-analytics - Generate interactive, beautiful and insightful chat analysis reports (TypeScript)

README

        


![Logo-Dark](assets/images/logos/app_dark.svg#gh-dark-mode-only)

![Logo-Light](assets/images/logos/app_light.svg#gh-light-mode-only)

Generate interactive, beautiful and insightful chat analysis reports


[Open App](https://chatanalytics.app) • [View Demo](https://chatanalytics.app/demo) • [Use CLI](#cli)

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/mlomb/chat-analytics/cicd.yml)

[![codecov](https://codecov.io/gh/mlomb/chat-analytics/branch/main/graph/badge.svg)](https://codecov.io/gh/mlomb/chat-analytics)

[![npm](https://img.shields.io/npm/v/chat-analytics)](https://www.npmjs.com/package/chat-analytics)

[![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/mlomb/chat-analytics)

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate/?hosted_button_id=NKHZJPKFJ34WJ)



---

A web app that takes chat exports from supported platforms and generates a single HTML file containing information, statistics and interactive graphs about them. Privacy is its main concern; chat data never leaves the device when generating reports. Selfhost with Docker!  

|  💬 MESSAGES |  🅰️ LANGUAGE | 😃 EMOJI | 🔗 LINKS | 📞 CALLS | 🌀 INTERACTION | 💙 SENTIMENT | 📅 TIMELINE |

|--|--|--|--|--|--|--|--|

|  |  |  |  |  |  |  |  |

You can interact with [the demo here](https://chatanalytics.app/demo)!

## Chat platform support

You can generate reports from the following platforms:

| Platform  | Formats supported                                                                | Text content | Edits & Replies  | Attachment Types                                                                    | Reactions        | Profile picture        | Mentions    | Calls |

|-----------|----------------------------------------------------------------------------------|--------------|------------------|-------------------------------------------------------------------------------------|------------------|------------------------|-------------|-------|

| Discord   | `json` from [DiscordChatExporter](https://github.com/Tyrrrz/DiscordChatExporter) | ✅            | ✅                | ✅                                                                                   | ✅                | ✅ (until link expires) | ✅ (as text) | ✅ |

| Messenger | `json` from [Facebook DYI export](https://www.facebook.com/dyi)                  | ✅            | ❌                | ✅                                                                                   | ❌                | ❌                      | ✅ (as text) | ❌ |

| Telegram  | `json` from [Telegram Desktop](https://desktop.telegram.org/)                    | ✅            | ✅                | ✅                                                                                   | ❌ (not provided) | ❌                      | ✅ (as text) | ✅ |

| WhatsApp  | `txt` or `zip` exported from a phone                                             | ✅            | ❌ (not provided) | ✅* (if exported from iOS)
🟦 (generic if exported from Android) | ❌ (not provided) | ❌                      | ✅ (as text) | ❌ |

* not all languages are supported, check [WhatsApp.ts](/pipeline/parse/parsers/WhatsApp.ts).

You can't combine exports from different platforms.  

The contribution of [new platform parsers](/docs/PIPELINE.md#writing-a-new-parser) is always welcomed 🙂

## Privacy & Analytics

Since all chat data always stays in the browser, there is zero risk of someone reading your chats. Note that **the report HTML file contains sensitive information** (one may reconstruct message contents for every message), so share your reports with people you trust.

The site does not use cookies either and uses a self-hosted version of [Plausible](https://plausible.io). All events do not contain PII and the information is segmented (e.g. 1MB-10MB, etc.). Since I want full transparency, you can check the [site analytics here](https://p.chatanalytics.app/chatanalytics.app).

## CLI

You can generate reports from the command line using `npx chat-analytics`:

```

Usage: chat-analytics -p  -i 

Options:

      --help      Show help                                            [boolean]

      --version   Show version number                                  [boolean]

  -p, --platform  The platform to generate for

   [string] [required] [choices: "discord", "messenger", "telegram", "whatsapp"]

  -i, --inputs    The input file(s) to use (glob)             [array] [required]

  -o, --output    The output HTML filename     [string] [default: "report.html"]

      --demo      Mark the report as a demo           [boolean] [default: false]

```

For example:

```sh

npx chat-analytics -p discord -i "exported/*.json" -o report.html

```

## Docs & Development

You can read [docs/README.md](/docs/README.md) for technical details, and [docs/DEV.md](/docs/DEV.md) for development instructions.  

In [docs/TODO.md](/docs/TODO.md) you can find ideas and pending stuff to be implemented.

## Acknowledgements

* [FastText](https://fasttext.cc/), a library by Facebook for efficient sentence classification. MIT licensed.

* [lid.176.ftz model](https://fasttext.cc/docs/en/language-identification.html), provided by FastText developers for language identification. Distributed under [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/).

* [multilang-sentiment](https://github.com/marcellobarile/multilang-sentiment), for the translated AFINN database. MIT licensed.

* Emoji sentiment data from the work of Kralj Novak, Petra; Smailović, Jasmina; Sluban, Borut and Mozetič, Igor, 2015, Emoji Sentiment Ranking 1.0, Slovenian language resource repository CLARIN.SI, http://hdl.handle.net/11356/1048. Licensed with [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).

* [stopwords-iso](https://github.com/stopwords-iso/stopwords-iso) for a collection of stopwords in a variety of languages. MIT licensed.

* All the libraries and tools that made this project possible 😀

## License

AGPLv3. See [LICENSE](LICENSE).