Merge pull request #123 from lucasrodes/release/0.5.0

Release/0.5.0

Author: lucasrodes

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.1
+current_version = 0.5.0.rc0
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(.(?P<pre>[a-z]+)(?P<prenum>\d+))?
 serialize = 
 	{major}.{minor}.{patch}.{pre}{prenum}

.coveragerc

@@ -1,6 +1,8 @@
 [run]
 branch = True
-omit = whatstk/tests/*
+omit = 
+        whatstk/tests/*
+        whatstk/scripts/*
 
 [report]
 fail_under=80

.gitignore

@@ -282,4 +282,8 @@ reports
 
 docs/_build/
 package-lock.json
-version-changes
+version-changes
+
+client_secrets.json
+settings.yaml
+credentials.json

.travis.yml

@@ -7,28 +7,45 @@ python:
 git:
   depth: false
 before_install:
+  - pip install --upgrade pip
+install:
   # - git fetch --tags
+  # 
   - pip install -r requirements-test.txt
   - pip install -r requirements-flake.txt
-install:
   - ls -l
   - pip uninstall whatstk
-  - pip install -e .
+  - pip install .[full]
+  # - ls -l /home/travis/virtualenv/python3.7.1/lib/python3.7/site-packages/whatstk/whatsapp/assets/
+  - cat MANIFEST.in
   - mkdir -p tests/chats/hformats tests/chats/merge
   - whatstk-generate-chat --size 500 --output-path tests/chats/hformats/  # Generate chats for hformat checks
   - whatstk-generate-chat --size 300 --last-timestamp 2019-09-01 --hformats '%Y-%m-%d, %H:%M - %name:' --output-path tests/chats/merge/ --filenames file1.txt
   - whatstk-generate-chat --size 300 --last-timestamp 2020-01-01 --hformats '%Y-%m-%d, %H:%M - %name:' --output-path tests/chats/merge/ --filenames file2.txt
 #pip install -r requirements.txt 
 script:
   - flake8 --max-complexity=10 --docstring-convention=google --max-line-length=120 whatstk
-  - pytest --cov-report term --cov=whatstk tests/
+  - pytest --cov-report term --cov=whatstk tests
 after_success:
   - codecov # submit coverage
 
 jobs:
   include:
+    # perform a linux build
+    # - services: docker
+    # and a windows build
+    - os: windows
+      language: shell
+      before_install:
+        - choco upgrade python -y --version 3.8.6
+        - export PATH="/c/Python38:/c/Python38/Scripts:$PATH"
+        # make sure it's on PATH as 'python3'
+        - ln -s /c/Python38/python.exe /c/Python38/python3.exe
     - stage: deploy
       python: 3.8
+      before_deploy:
+        - python3 -m pip install cibuildwheel==1.11.0
+        - python3 -m cibuildwheel --output-dir wheelhouse
       deploy:
         - provider: pypi
           user: $USER_PYPI

MANIFEST.in

@@ -2,6 +2,9 @@ include *.md
 include LICENSE
 include requirements.txt
 include requirements-test.txt
+include requirements-flake.txt
+include requirements-docs.txt
+include whatstk/whatsapp/assets/header_format_support.json
 include .coveragerc
 
 recursive-include altair *.py *.json *.ipynb *.html

README.md

@@ -5,13 +5,13 @@
 </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&">
+    <img alt="Package version" src="https://img.shields.io/badge/pypi-0.5.0.rc0-blue.svg?&color=25D366&logo=whatsapp&">
   </a>
 </p>
 <!-- style=for-the-badge -->
 
 <p align="left">
-  <a href="https://travis-ci.org/lucasrodes/whatstk">
+  <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">
@@ -20,15 +20,15 @@
   <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.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>
@@ -64,29 +64,32 @@ It is distributed under the GPL-3.0 license.
 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)._
 
-#### Convert chat to csv
-Easily convert your txt chat file to csv using command `whatstk-to-csv`.
+#### Load chat as a DataFrame
 
-```bash
-$ whatstk-to-csv [input_filename] [output_filename]
+```python
+from whatstk import df_from_txt_whatsapp
+df = df_from_txt_whatsapp("path/to/chat.txt")
 ```
 
-#### Load chat in python
-You can also load the exported txt file with python.
+#### Convert chat to csv
 
-```python
-from whatstk import WhatsAppChat
-from whatstk.data import whatsapp_urls
-chat = WhatsAppChat.from_source(filepath=whatsapp_urls.LOREM)
+```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 

docs/conf.py

@@ -19,17 +19,18 @@
 from sphinx.ext.autosummary import get_documenter
 from docutils.parsers.rst import directives
 from sphinx.util.inspect import safe_getattr
+from datetime import datetime
 
 
 # -- Project information -----------------------------------------------------
 
 project = 'whatstk'
-copyright = '2020, sociepy'
-copy_right = '2020, sociepy'
+copyright = f'{datetime.now().year}, sociepy'
+copy_right = f'{datetime.now().year}, sociepy'
 author = 'lucasrodes'
 
 # The full version, including alpha/beta/rc tags
-version = 'v0.4.1'
+version = 'v0.5.0.rc0'
 
 
 # -- General configuration ---------------------------------------------------

docs/source/about.rst

@@ -46,35 +46,55 @@ This project is on `PyPI <https://pypi.org/project/whatstk/>`_, install it with
 
     pip install whatstk
 
-Project has been tested with Python 3.7-3.8.
+Project has been tested in Python>=3.7.
 
 From source
 ^^^^^^^^^^^
-Clone the project from the `official repository <https://github.com/lucasrodes/whatstk/>`_
+Clone the project from the `official repository <https://github.com/lucasrodes/whatstk/>`_ and install it locally 
 
 .. code-block:: bash
 
     git clone https://github.com/lucasrodes/whatstk.git
+    cd whatstk
+    pip install .
 
+Extensions
+^^^^^^^
+To use Google Drive or Chat Generation support, install the library along with the corresponding extensions:
+
+.. code-block:: bash
 
-and install it locally 
+    pip install whatstk[gdrive]
 
 .. code-block:: bash
 
-    cd whatstk
-    pip install .
+    pip install whatstk[generate]
+
+Or install the full suite:
+
+.. code-block:: bash
+
+    pip install whatstk[full]
 
 
 Develop
 ^^^^^^^
 You can also install the version in development directly from github
-`develop <https://github.com/lucasrodes/whatstk/tree/develop>`_ branch.
+`develop <https://github.com/lucasrodes/whatstk/tree/develop>`_ branch. 
+
+.. code-block:: bash
+
+    pip install git+https://github.com/lucasrodes/whatstk.git@developDevelop
+^^^^^^^
+You can also install the version in development directly from github
+`develop <https://github.com/lucasrodes/whatstk/tree/develop>`_ branch. 
 
 .. code-block:: bash
 
-    pip install  
     pip install git+https://github.com/lucasrodes/whatstk.git@develop
 
+Note: It requires `git <https://git-scm.com/>`_ to be installed.
+
 ----
 
 Support

docs/source/api/cmd/cmd_chat_gen.rst

@@ -1,12 +1,23 @@
 ``whatstk-generate-chat``
 =========================
 
+.. warning::
+
+    To use the chat generation functionalities, install the library with the corresponding extension (ignore the
+    ``--upgrade`` option if you haven't installed the library):
+
+    .. code-block::
+
+        pip install whatstk[generate] --upgrade
+
 Generate random WhatsApp chat.
 
 .. code-block:: bash
 
     whatstk-generate-chat --help
-    usage: Generate chat. [-h] -o OUTPUT_PATH
+    usage: Generate chat. Make sure to install the library with required extension: pip install whatstk[generate]
+    --upgrade
+           [-h] -o OUTPUT_PATH
                           [--filenames FILENAMES [FILENAMES ...]] [-s SIZE]
                           [-f HFORMATS [HFORMATS ...]]
                           [--last-timestamp LAST_TIMESTAMP] [-v]

docs/source/api/whatstk.utils.rst

@@ -19,6 +19,16 @@ whatstk.utils.chat\_merge
 
 ----
 
+whatstk.utils.gdrive
+------------------------
+
+.. automodule:: whatstk.utils.gdrive
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+----
+
 whatstk.utils.exceptions
 ------------------------
 
@@ -36,3 +46,5 @@ whatstk.utils.utils
    :members:
    :undoc-members:
    :show-inheritance:
+
+

docs/source/code_examples/index.rst

@@ -7,9 +7,10 @@ Basic examples
 .. toctree:: 
    :maxdepth: 1
 
-   Load chat <load_chat>
-   Load chat from multiple sources <load_chat_multiple>
-   Load chat with specific hformat  <load_chat_hformat>
+   Load WhatsApp chat <load_chat>
+   Load WhatsApp chat from multiple sources <load_chat_multiple>
+   Load WhatsApp chat from Google Drive  <load_chat_gdrive>
+   Load WhatsApp chat with specific hformat  <load_chat_hformat>
    Rename usernames <load_chat_multiple>
 
 Visualisations

docs/source/code_examples/load_chat.rst

@@ -1,5 +1,5 @@
-Load chat
-==============
+Load WhatsApp chat
+==================
 
 Once you have :doc:`exported <../getting_started/export_chat>` a chat it is time to load it in python.
 
@@ -14,8 +14,8 @@ develop/chats/whatsapp/lorem.txt>`_, which is available online, using library cl
     >>> chat = WhatsAppChat.from_source(filepath=whatsapp_urls.LOREM)
 
 Once loaded, we can check some of the chat messages by accessing its attribute :func:`df <whatstk.WhatsAppChat.df>`,
-which is a pandas.DataFrame with columns `username` (name of user sending the message), `message` (message sent) and
-`date` index (timestamp of message).
+which is a pandas.DataFrame with columns `date` index (timestamp of message), `username` (name of user sending the
+message) and `message` (message sent).
 
 .. code-block:: python
 
@@ -40,4 +40,12 @@ Also, getting a list with the chat members is simple
 .. code-block:: python
 
     >>> chat.users
-    ['+1 123 456 789', 'Giuseppe', 'John', 'Mary']
+    ['+1 123 456 789', 'Giuseppe', 'John', 'Mary']
+
+----
+
+.. seealso::
+
+    * :ref:`Load WhatsApp chat from multiple sources <Load WhatsApp chat from multiple sources>`
+    * :ref:`Load WhatsApp chat from Google Drive <Load WhatsApp chat from Google Drive>`
+    * :ref:`Load WhatsApp chat with specific hformat <Load WhatsApp chat with specific hformat>`