whatsmapper

Convert Whatsapp to other file formats

Usage

python whatsmap.py
usage: whatsmap [-h] [-t TRANSCRIPT]

utility to map a whatsmap chat transcript to HTML

options:
  -h, --help            show this help message and exit
  -t TRANSCRIPT, --transcript TRANSCRIPT
                        location of the whatsapp transcript file

for more information visit https://github.com/ross-spencer/whatsmapper/

Whatsapp folder structure

An export (with media) should output a zip folder, e.g.

'WhatsApp Chat - Digipres Chat.zip'

Extract the zip. It should should have a structure along the lines of:

WhatsApp Chat - Digipres Chat/
├── 00000002-PHOTO-2017-05-24-06-15-02.jpg
├── 00000006-PHOTO-2017-05-29-03-35-35.mp4
└── _chat.txt

To convert this to html run:

whatsmap -t "/path/to/WhatsApp Chat - Digipres Chat/_chat.txt"

Or:

python3 -m whatsmap.py -t "/path/to/WhatsApp Chat - Digipres Chat/_chat.txt"

And to output to a html file, simply add:

 > whatsapp_chat.html

Providing a custom filename as required, e.g.

whatsmap -t "/path/to/WhatsApp Chat - Digipres Chat/_chat.txt" > my_whatsapp_chat.html

Developer install

pip

Setup a virtual environment venv and install the local development requirements as follows:

python3 -m venv venv
source venv/bin/activate
python -m pip install -r requirements/local.txt

tox

Run tests (all)

python -m tox

Run tests-only

python -m tox -e py3

Run linting-only

python -m tox -e linting

pre-commit

Pre-commit can be used to provide more feedback before committing code. This reduces reduces the number of commits you might want to make when working on code, it's also an alternative to running tox manually.

To set up pre-commit, providing pip install has been run above:

• pre-commit install

This repository contains a default number of pre-commit hooks, but there may be others suited to different projects. A list of other pre-commit hooks can be found here.

Packaging

The Makefile contains helper functions for packaging and release.

Makefile functions can be reviewed by calling make from the root of this repository:

clean                          Clean the package directory
help                           Print this help message.
package-check                  Check the distribution is valid
package-deps                   Upgrade dependencies for packaging
package-source                 Package the source code
package-upload                 Upload package to pypi
package-upload-test            Upload package to test.pypi
tar-source                     Package repository as tar for easy distribution

pyproject.toml

Packaging consumes the metadata in pyproject.toml which helps to describe the project on the official pypi.org repository. Have a look at the documentation and comments there to help you create a suitably descriptive metadata file.

Local packaging

To create a python wheel for testing locally, or distributing to colleagues run:

• make package-source

A tar and whl file will be stored in a dist/ directory. The whl file can be installed as follows:

• pip install <your-package>.whl

Publishing

Publishing for public use can be achieved with:

• make package-upload-test or make package-upload

make-package-upload-test will upload the package to test.pypi.org which provides a way to look at package metadata and documentation and ensure that it is correct before uploading to the official pypi.org repository using make package-upload.