Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucasrodes/whatstk
WhatsApp chats as dataframes. Python toolkit to analyse and parse WhatsApp chats.
https://github.com/lucasrodes/whatstk
machinelearning pandas pandas-dataframe parser whatsapp whatsapp-analysis whatsapp-group whatsapp-parser whatsapp-statistics
Last synced: 3 days ago
JSON representation
WhatsApp chats as dataframes. Python toolkit to analyse and parse WhatsApp chats.
- Host: GitHub
- URL: https://github.com/lucasrodes/whatstk
- Owner: lucasrodes
- License: gpl-3.0
- Created: 2016-12-05T00:44:03.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-06-30T00:05:20.000Z (7 months ago)
- Last Synced: 2024-10-15T16:16:32.579Z (4 months ago)
- Topics: machinelearning, pandas, pandas-dataframe, parser, whatsapp, whatsapp-analysis, whatsapp-group, whatsapp-parser, whatsapp-statistics
- Language: Python
- Homepage: https://whatstk.lcsrg.me/
- Size: 40.6 MB
- Stars: 122
- Watchers: 3
- Forks: 23
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
whatstk: analyze WhatsApp chats with python
---
**Try the [live demo parser](https://whatstk.streamlit.app/) to convert your chats to CSV**
---
**whatstk** is a python package providing tools to parse, analyze and visualise WhatsApp chats developed under the
**[sociepy](https://sociepy.org)** project. Easily convert your chats to csv or simply visualise some stats using
the provided command-line tools or python. The package uses [pandas](https://github.com/pandas-dev/pandas) to process
the data and [plotly](https://github.com/plotly/plotly.py) to visualise it.
It is distributed under the GPL-3.0 license.
⭐ Please **star** our project if you found it interesting to **give us some dopamine** 😄!
### Content
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Documentation](https://whatstk.readthedocs.io/en/stable/)
- [Contribute](#contribute)
- [Covered in](#covered-in)
- [Citation](#citation)
## Installation
```
pip install whatstk
```
Install develop version (not stable):
```
pip install git+https://github.com/lucasrodes/whatstk.git@develop
```
_More details [here](https://whatstk.readthedocs.io/en/stable/source/about.html#installation-compatibility)_
## Getting Started
For a rapid introduction, check this [tutorial on Medium](https://towardsdatascience.com/analyzing-whatsapp-chats-with-python-20d62ce7fe2d).
#### Export your chat using your phone:
_See [instructions](https://whatstk.readthedocs.io/en/stable/source/getting_started/export_chat.html)._
#### Load chat as a DataFrame
```python
from whatstk import df_from_whatsapp
df = df_from_whatsapp("path/to/chat.txt")
```
**NOTE:** You can now also load directly from a zip chat (iOS export).
#### Convert chat to csv
```bash
$ whatstk-to-csv [input_filename] [output_filename]
```
#### More examples
_See more in sections [getting started](https://whatstk.readthedocs.io/en/stable/source/getting_started/index.html) and
[examples](https://whatstk.readthedocs.io/en/stable/source/code_examples/index.html)._
## Documentation
_See [official documentation](https://whatstk.readthedocs.io/en/stable/)._
## Contribute
_See [contribute section](https://whatstk.readthedocs.io/en/stable/source/contribute.html)._
## License
[GPL-3.0](LICENSE)
## Citation
Lucas Rodés-Guirao. "whatstk, WhatsApp analysis and parsing toolkit", https://github.com/lucasrodes/whatstk
## Covered in
- [Your Whatsapp Chat History in Cool Graphs](https://deepnote.com/@batmanscode/Your-Whatsapp-Chat-History-in-Cool-Graphs-mQoSsYjUSw29D4nZDs_KwA), by [@batmanscode](https://github.com/batmanscode).
- [WhatsAppening to the news](https://whatsappening.joltetn.eu/), by [@enric1994](https://github.com/enric1994)
- [whatsappening source code](https://github.com/enric1994/whatsappening), by [@enric1994](https://github.com/enric1994)