Metadata-Version: 2.1
Name: whatstk
Version: 0.4.1
Summary: Parser and analytics tools for WhatsApp group chats
Home-page: http://github.com/lucasrodes/whatstk
Author: Lucas Rodes-Guirao
Author-email: hi@lcsrg.me
License: GPL-v3
Project-URL: Documentation, https://whatstk.lcsrg.me/
Project-URL: Github, http://github.com/lucasrodes/whatstk
Project-URL: Bug Tracker, https://github.com/lucasrodes/whatstk/issues
Description: <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.4.1-blue.svg?&color=25D366&logo=whatsapp&">
          </a>
        </p>
        <!-- style=for-the-badge -->
        
        <p align="left">
          <a href="https://travis-ci.org/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://www.python.org/downloads/release/python-3/">
            <img alt="Python 3" src="https://img.shields.io/badge/python-3.7|3.8|3.9-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="http://github.com/lucasrodes/whatstk">
            <img alt="HitCount" src="https://views.whatilearened.today/views/github/lucasrodes/whatstk.svg">
          </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>
        
        ----
        <!-- [![Downloads](https://pepy.tech/badge/whatstk)](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)
        * [Citation](#citation)
        
        ## Installation
        
        ```
        pip install whatstk
        ```
        
        _More details [here](https://whatstk.readthedocs.io/en/stable/source/about.html#installation-compatibility)_
        
        ## Getting Started
        
        #### Export your chat using your phone: 
        _See [instructions](https://whatstk.readthedocs.io/en/stable/source/getting_started/export_chat.html)._
        
        #### Convert chat to csv
        Easily convert your txt chat file to csv using command `whatstk-to-csv`.
        
        ```bash
        $ whatstk-to-csv [input_filename] [output_filename]
        ```
        
        #### Load chat in python
        You can also load the exported txt file with python.
        
        ```python
        from whatstk import WhatsAppChat
        from whatstk.data import whatsapp_urls
        chat = WhatsAppChat.from_source(filepath=whatsapp_urls.LOREM)
        ```
        
        #### 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
        
Keywords: whatsapp analysis parser chat
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
