<div align="left">
<img src="https://raw.githubusercontent.com/lucasrodes/whatstk/develop/assets/logo.svg" width="70%">
</div>
<h1 align="left" style="border-bottom: none;"> whatstk: analyze WhatsApp chats with python
</h1>
<p align="left">
<a href="#">
<img alt="Package version" src="https://img.shields.io/badge/pypi-0.6.2-blue.svg?&color=25D366&logo=whatsapp&">
</a>
</p>
<!-- style=for-the-badge -->
<p align="left">
<a href="https://travis-ci.com/lucasrodes/whatstk">
<img alt="Build Status" src="https://travis-ci.com/lucasrodes/whatstk.svg?branch=develop">
</a>
<a href="https://codecov.io/gh/lucasrodes/whatstk">
<img alt="codecov" src="https://codecov.io/gh/lucasrodes/whatstk/branch/master/graph/badge.svg">
</a>
<a href='https://whatstk.readthedocs.io/en/stable/?badge=stable'>
<img src='https://readthedocs.org/projects/whatstk/badge/?version=stable' alt='Documentation Status' />
</a>
<a href="https://towardsdatascience.com/analyzing-whatsapp-chats-with-python-20d62ce7fe2d">
<img alt="Tutorial" src="https://img.shields.io/badge/tutorial-on_medium-1a8917.svg?&logo=medium&logoColor=white">
</a>
<a href="https://www.python.org/downloads/release/python-3/">
<img alt="Python 3" src="https://img.shields.io/badge/python-3.8|3.9|3.10|3.11-blue.svg?&logo=python&logoColor=yellow">
</a>
<a href="https://pepy.tech/badge/whatstk">
<img alt="Number of downloads" src="https://pepy.tech/badge/whatstk">
</a>
<a href="https://github.com/lucasrodes/whatstk/blob/master/LICENSE">
<img alt="GitHub license" src="https://img.shields.io/github/license/lucasrodes/whatstk.svg?">
</a>
<a href="https://gitter.im/sociepy/whatstk?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
<img alt="Join the chat at https://gitter.im/sociepy/whatstk" src="https://badges.gitter.im/sociepy/whatstk.svg">
</a>
</p>
---
**Try the [live demo parser](https://whatstk.streamlit.app/) to convert your chats to CSV**
---
<!-- [](https://pepy.tech/project/whatstk) -->
<!-- > [Get the Desktop App](https://lcsrg.me/whatstk-gui) -->
**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_txt_whatsapp
df = df_from_txt_whatsapp("path/to/chat.txt")
```
#### 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)
Raw data
{
"_id": null,
"home_page": "http://github.com/lucasrodes/whatstk",
"name": "whatstk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "whatsapp analysis parser chat",
"author": "Lucas Rodes-Guirao",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/cd/6b/1f670e138112474f61c6189c547bb0bd0990a3bd6de87702be31a52f2480/whatstk-0.6.2.tar.gz",
"platform": null,
"description": "<div align=\"left\">\n <img src=\"https://raw.githubusercontent.com/lucasrodes/whatstk/develop/assets/logo.svg\" width=\"70%\">\n</div>\n<h1 align=\"left\" style=\"border-bottom: none;\"> whatstk: analyze WhatsApp chats with python\n</h1>\n<p align=\"left\">\n <a href=\"#\">\n <img alt=\"Package version\" src=\"https://img.shields.io/badge/pypi-0.6.2-blue.svg?&color=25D366&logo=whatsapp&\">\n </a>\n</p>\n<!-- style=for-the-badge -->\n\n<p align=\"left\">\n <a href=\"https://travis-ci.com/lucasrodes/whatstk\">\n <img alt=\"Build Status\" src=\"https://travis-ci.com/lucasrodes/whatstk.svg?branch=develop\">\n </a>\n <a href=\"https://codecov.io/gh/lucasrodes/whatstk\">\n <img alt=\"codecov\" src=\"https://codecov.io/gh/lucasrodes/whatstk/branch/master/graph/badge.svg\">\n </a>\n <a href='https://whatstk.readthedocs.io/en/stable/?badge=stable'>\n <img src='https://readthedocs.org/projects/whatstk/badge/?version=stable' alt='Documentation Status' />\n </a>\n <a href=\"https://towardsdatascience.com/analyzing-whatsapp-chats-with-python-20d62ce7fe2d\">\n <img alt=\"Tutorial\" src=\"https://img.shields.io/badge/tutorial-on_medium-1a8917.svg?&logo=medium&logoColor=white\">\n </a>\n <a href=\"https://www.python.org/downloads/release/python-3/\">\n <img alt=\"Python 3\" src=\"https://img.shields.io/badge/python-3.8|3.9|3.10|3.11-blue.svg?&logo=python&logoColor=yellow\">\n </a>\n <a href=\"https://pepy.tech/badge/whatstk\">\n <img alt=\"Number of downloads\" src=\"https://pepy.tech/badge/whatstk\">\n </a>\n <a href=\"https://github.com/lucasrodes/whatstk/blob/master/LICENSE\">\n <img alt=\"GitHub license\" src=\"https://img.shields.io/github/license/lucasrodes/whatstk.svg?\">\n </a>\n <a href=\"https://gitter.im/sociepy/whatstk?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\">\n <img alt=\"Join the chat at https://gitter.im/sociepy/whatstk\" src=\"https://badges.gitter.im/sociepy/whatstk.svg\">\n </a>\n</p>\n\n---\n\n**Try the [live demo parser](https://whatstk.streamlit.app/) to convert your chats to CSV**\n\n---\n\n<!-- [](https://pepy.tech/project/whatstk) -->\n<!-- > [Get the Desktop App](https://lcsrg.me/whatstk-gui) -->\n\n**whatstk** is a python package providing tools to parse, analyze and visualise WhatsApp chats developed under the\n**[sociepy](https://sociepy.org)** project. Easily convert your chats to csv or simply visualise some stats using\nthe provided command-line tools or python. The package uses [pandas](https://github.com/pandas-dev/pandas) to process\nthe data and [plotly](https://github.com/plotly/plotly.py) to visualise it.\n\nIt is distributed under the GPL-3.0 license.\n\n\u2b50 Please **star** our project if you found it interesting to **give us some dopamine** \ud83d\ude04!\n\n### Content\n\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [Documentation](https://whatstk.readthedocs.io/en/stable/)\n- [Contribute](#contribute)\n- [Covered in](#covered-in)\n- [Citation](#citation)\n\n## Installation\n\n```\npip install whatstk\n```\n\nInstall develop version (not stable):\n\n```\npip install git+https://github.com/lucasrodes/whatstk.git@develop\n```\n\n_More details [here](https://whatstk.readthedocs.io/en/stable/source/about.html#installation-compatibility)_\n\n## Getting Started\n\nFor a rapid introduction, check this [tutorial on Medium](https://towardsdatascience.com/analyzing-whatsapp-chats-with-python-20d62ce7fe2d).\n\n#### Export your chat using your phone:\n\n_See [instructions](https://whatstk.readthedocs.io/en/stable/source/getting_started/export_chat.html)._\n\n#### Load chat as a DataFrame\n\n```python\nfrom whatstk import df_from_txt_whatsapp\ndf = df_from_txt_whatsapp(\"path/to/chat.txt\")\n```\n\n#### Convert chat to csv\n\n```bash\n$ whatstk-to-csv [input_filename] [output_filename]\n```\n\n#### More examples\n\n_See more in sections [getting started](https://whatstk.readthedocs.io/en/stable/source/getting_started/index.html) and\n[examples](https://whatstk.readthedocs.io/en/stable/source/code_examples/index.html)._\n\n## Documentation\n\n_See [official documentation](https://whatstk.readthedocs.io/en/stable/)._\n\n## Contribute\n\n_See [contribute section](https://whatstk.readthedocs.io/en/stable/source/contribute.html)._\n\n## License\n\n[GPL-3.0](LICENSE)\n\n## Citation\n\nLucas Rod\u00e9s-Guirao. \"whatstk, WhatsApp analysis and parsing toolkit\", https://github.com/lucasrodes/whatstk\n\n## Covered in\n\n- [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).\n- [WhatsAppening to the news](https://whatsappening.joltetn.eu/), by [@enric1994](https://github.com/enric1994)\n- [whatsappening source code](https://github.com/enric1994/whatsappening), by [@enric1994](https://github.com/enric1994)\n",
"bugtrack_url": null,
"license": "GPL-v3",
"summary": "Parser and analytics tools for WhatsApp group chats",
"version": "0.6.2",
"project_urls": {
"Bug Tracker": "https://github.com/lucasrodes/whatstk/issues",
"Documentation": "https://whatstk.readthedocs.io/en/stable/",
"Github": "http://github.com/lucasrodes/whatstk",
"Homepage": "http://github.com/lucasrodes/whatstk"
},
"split_keywords": [
"whatsapp",
"analysis",
"parser",
"chat"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd6b1f670e138112474f61c6189c547bb0bd0990a3bd6de87702be31a52f2480",
"md5": "4367e8f84df2747422ab0dbe10398c07",
"sha256": "48a815fa4a79008e7a0315faabb602d0f5e4f15d6731ad6695d45a6d5c848ad2"
},
"downloads": -1,
"filename": "whatstk-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "4367e8f84df2747422ab0dbe10398c07",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 48009,
"upload_time": "2023-08-10T10:49:17",
"upload_time_iso_8601": "2023-08-10T10:49:17.809564Z",
"url": "https://files.pythonhosted.org/packages/cd/6b/1f670e138112474f61c6189c547bb0bd0990a3bd6de87702be31a52f2480/whatstk-0.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-10 10:49:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lucasrodes",
"github_project": "whatstk",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"requirements": [],
"lcname": "whatstk"
}
JSON
