/yowsup

The WhatsApp lib

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

yowsup Build Status


yowsup is a python library that enables building applications that can communicate with WhatsApp users. The project started as the protocol engine behind Wazapp for Meego and OpenWA for BB10. Now as a standalone library it can be used to power any custom WhatsApp client.

updated: 2019-05-07
yowsup version: 3.2.3
yowsup-cli version: 3.2.0
requires:
- python>=2.7,<=3.7
- consonance==0.1.3-1
- python-axolotl==0.2.2
- protobuf>=3.6.0
- six==1.10
uses:
 - argparse [yowsup-cli]
 - readline [yowsup-cli]
 - pillow [send images]
 - tqdm [mediasink demo]
 - requests [mediasink demo]

See also

During maintenance of yowsup, several projects have been spawned in order to support different features that get introduced by WhatsApp. Some of those features are not necessarily exclusive to WhatsApp and therefore it only made sense to maintain some parts as standalone projects:

Quickstart

Installation

Install using setup.py to pull all Python dependencies, or pip:

pip install yowsup

Linux

You need to have installed Python headers (probably from python-dev package) and ncurses-dev, then run

python setup.py install

FreeBSD (*BSD)

You need to have installed: py27-pip-7.1.2(+), py27-sqlite3-2.7.11_7(+), then run

pip install yowsup

Mac OS

python setup.py install

Administrators privileges might be required, if so then run with 'sudo'

Windows

  • Install mingw compiler
  • Add mingw to your PATH
  • In PYTHONPATH\Lib\distutils create a file called distutils.cfg and add these lines:
[build]
compiler=mingw32
  • Install gcc: mingw-get.exe install gcc
  • Install zlib
  • python setup.py install

License:

As of January 1, 2015 yowsup is licensed under the GPLv3+: http://www.gnu.org/licenses/gpl-3.0.html.