Skip to content

Commit

Permalink
Merge pull request #134 from lucasrodes/release/0.6.0
Browse files Browse the repository at this point in the history
release(v0.6.0)
  • Loading branch information
lucasrodes authored Apr 1, 2023
2 parents bcb9cf7 + daa3d03 commit e0dc735
Show file tree
Hide file tree
Showing 36 changed files with 512 additions and 448 deletions.
3 changes: 1 addition & 2 deletions .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.5.0
current_version = 0.6.0
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(.(?P<pre>[a-z]+)(?P<prenum>\d+))?
serialize =
{major}.{minor}.{patch}.{pre}{prenum}
Expand All @@ -21,4 +21,3 @@ values =
[bumpversion:file:whatstk/__init__.py]

[bumpversion:file:docs/conf.py]

15 changes: 8 additions & 7 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
dist: xenial
dist: focal
language: python
python:
- 3.7
- 3.8
- 3.9
- "3.10"
- "3.11"
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
- ls -l
Expand All @@ -19,12 +20,12 @@ install:
# - 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 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
#pip install -r requirements.txt
script:
- flake8 --max-complexity=10 --docstring-convention=google --max-line-length=120 whatstk
- flake8 --max-complexity=10 --docstring-convention=google --max-line-length=120 --ignore=ANN101,ANN102 whatstk
- pytest --cov-report term --cov=whatstk tests
after_success:
- codecov # submit coverage
Expand All @@ -42,7 +43,7 @@ jobs:
# make sure it's on PATH as 'python3'
- ln -s /c/Python38/python.exe /c/Python38/python3.exe
- stage: deploy
python: 3.8
python: 3.10
deploy:
- provider: pypi
user: $USER_PYPI
Expand Down
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</h1>
<p align="left">
<a href="#">
<img alt="Package version" src="https://img.shields.io/badge/pypi-0.5.0-blue.svg?&color=25D366&logo=whatsapp&">
<img alt="Package version" src="https://img.shields.io/badge/pypi-0.6.0-blue.svg?&color=25D366&logo=whatsapp&">
</a>
</p>
<!-- style=for-the-badge -->
Expand All @@ -24,7 +24,7 @@
<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">
<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">
Expand All @@ -37,7 +37,8 @@
</a>
</p>

----
---

<!-- [![Downloads](https://pepy.tech/badge/whatstk)](https://pepy.tech/project/whatstk) -->
<!-- > [Get the Desktop App](https://lcsrg.me/whatstk-gui) -->

Expand All @@ -46,18 +47,18 @@
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.
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](#installation)
- [Getting Started](#getting-started)
- [Documentation](https://whatstk.readthedocs.io/en/stable/)
- [Contribute](#contribute)
- [Covered in](#covered-in)
- [Citation](#citation)

## Installation

Expand All @@ -74,9 +75,11 @@ 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:
#### 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
Expand All @@ -91,21 +94,26 @@ df = df_from_txt_whatsapp("path/to/chat.txt")
```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
_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
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
author = 'lucasrodes'

# The full version, including alpha/beta/rc tags
version = 'v0.5.0'
version = 'v0.6.0'


# -- General configuration ---------------------------------------------------
Expand Down
7 changes: 0 additions & 7 deletions docs/source/about.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,6 @@ Develop
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 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 git+https://github.com/lucasrodes/whatstk.git@develop
Expand Down
4 changes: 2 additions & 2 deletions docs/source/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ Note: You will need to add tests for your code. For this, you can check the curr
Adding new examples
-------------------
To add new examples, consider editing yourself a ``rst`` file in ``docs/source/`` directory in the repository. For
questions or doubts, join the `gitter group <https://gitter.im/whatstk/>`_.
questions or doubts, join the `gitter group <https://gitter.im/sociepy/whatstk>`_.

----

API discussions
---------------
Consider joining the `gitter group <https://gitter.im/whatstk/>`_.
Consider joining the `gitter group <https://gitter.im/sociepy/whatstk>`_.

----

Expand Down
16 changes: 8 additions & 8 deletions requirements-flake.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#
flake8
flake8-docstrings
flake8-bugbear
flake8-builtins
flake8-bandit
flake8-mutable
flake8-type-annotations
flake8-html
flake8~=6.0.0
flake8-docstrings~=1.7.0
flake8-bugbear~=23.3.0
flake8-builtins~=2.1.0
flake8-bandit~=4.1.0
flake8-mutable~=1.2.0
flake8-annotations~=3.0.0
flake8-html~=0.4.3
12 changes: 6 additions & 6 deletions requirements-test.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
pytest>=5.4.1
pytest-cov>=2.8.1
coverage>=4.5.1
codecov>=2.0.22
pytest-html==2.1.1
pytest-mock~=3.6.1
pytest~=7.2.0
pytest-cov~=4.0.0
coverage~=7.2.2
codecov~=2.1.0
pytest-html~=3.2.0
pytest-mock~=3.10.0
9 changes: 4 additions & 5 deletions requirements.txt
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
emoji==0.6.0
numpy~=1.19.1
pandas~=1.2.0
emoji~=2.2.0
numpy~=1.24.0
pandas~=1.5.0
plotly~=4.14.3
seaborn==0.11.1
certifi==2020.12.5
seaborn~=0.12.0
4 changes: 3 additions & 1 deletion run-tests.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## (1) Test dependencies (run this part only the first time)
## (1) Test dependencies (run this part only the first time).
# If using zsh, install using '\', i.e. `pip install -e .\[full\]`
# pip install -e .[full]

## (1.1) Install pytest dependencies
Expand All @@ -24,6 +25,7 @@ flake8 \
--docstring-convention=google\
--format=html --htmldir=reports/flake-report\
--max-line-length=120\
--ignore=ANN101,ANN102\
whatstk

## (3) Run tests
Expand Down
13 changes: 7 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@
requirements_docs = f.readlines()

requirements_gdrive = [
"PyDrive2~=1.8.2",
"PyYAML~=5.4.1",
"PyDrive2~=1.15.0",
"PyYAML~=6.0",
]

requirements_generate = [
"scipy~=1.6.0",
"python-lorem==1.1.2",
"scipy~=1.10.0",
"python-lorem==1.2.0",
]

requirements_full = requirements_gdrive + requirements_generate
Expand All @@ -45,7 +45,7 @@

setup(
name='whatstk',
version="0.5.0",
version="0.6.0",
description="Parser and analytics tools for WhatsApp group chats",
long_description=long_description,
long_description_content_type='text/markdown',
Expand All @@ -62,9 +62,10 @@
"Development Status :: 4 - Beta",
"Programming Language :: Python",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Operating System :: OS Independent",
],
Expand Down
8 changes: 4 additions & 4 deletions whatstk/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@

name = "whatstk"

__version__ = "0.5.0"
__version__ = "0.6.0"

__all__ = [
'WhatsAppChat',
'df_from_txt_whatsapp',
'FigureBuilder',
"WhatsAppChat",
"df_from_txt_whatsapp",
"FigureBuilder",
]
Loading

0 comments on commit e0dc735

Please sign in to comment.