whalesong 0.5.2

Whalesong is a python library to manage WebApps remotely. Currently WhatsappWeb is implemented

Whalesong is a python library to manage WebApps remotely. Currently WhatsappWeb is implemented

Documentation

http://whalesong.readthedocs.io/

Requirements

• Python 3.6+

• Geckodriver

• Firefox 50+

Development requirements

• node (only for development)

• npm (only for development)

• make (only for development)

Installation

$ pip install whalesong

Features

• Non blocking driver. It can do more than one thing at same time.

• Monitor feature. Python code could react to Javascript event.

• Iterator feature. Large item list are passed to Python as async iterators.

• Persistent Firefox profile.

• Easy way to build new features.

• AmpersandJS/BackboneJS models and collection monitor.

• AmpersandJS/BackboneJS field monitor.

• Monitor localStorage.

• Take screenshots (page and css elements).

Whatsapp features

• Monitor connection state.

• Monitor QR changes.

• Monitor stream state.

• It’s able to refresh QR.

• It’s able to take over session.

• List chats.

• List contacts.

• List messages

• Monitor new messages.

• Monitor unread messages.

• Monitor message acks.

• Monitor new contacts.

• Monitor new chats.

• Send text messages.

• Reply messages.

• Send VCard messages.

• Send Media (image/video/pdf) messages.

• Send seen to chats.

• Create groups

• Manage groups (add/kick/promote/demote people)

Changelog

See documentation

TODO

• Tests, tests, tests.

• Documentation.

• More examples.

• Missing Whatsapp features.

• Implement scriptlet for other WebApp (maybe Android Messages).

• Drop Selenium and Geckodriver.

• Create/Use a small footprint headless browser with async interface (like marionette).

• Push results. Avoid continuous polling.

Getting started

Install library requirements

$ make requirements

Build Javascript scriplet

You have to rebuild scriptlet after any change if you want to use in Python code.

$ make build-js

Beautify code

You must to beautify code before make a pull request. Ugly code will not be accepted.

$ make beautify

Examples

Raw driver examples

State monitor

It monitors Stream state, Connection state and localStorage. It prints any change on them. It takes a page screenshot on each stream state change.

It tries to own WhatsappWeb session, it means that it will restore session if you open a new session in other browser.

On the other hand, if session is not started, it will renew QR automatically when it expires. It will save QR image each time it changes.

$ PYTHONPATH=.:$PYTHONPATH python3 examples/driver/statemonitor.py

Get contacts

It prints contact list.

$ PYTHONPATH=.:$PYTHONPATH python3 examples/driver/getcontacts.py

Get chats

It prints chat list.

$ PYTHONPATH=.:$PYTHONPATH python3 examples/driver/getchats.py

Get messages

It prints message list and monitors it. So, if new messages are received it will print them. It monitors message acknowledgments and prints them, as well.

$ PYTHONPATH=.:$PYTHONPATH python3 examples/driver/getmessages.py

Whatsapp driver examples

State monitor

It monitors Stream state, Connection state and localStorage. It prints any change on them. It takes a page screenshot on each stream state change.

It tries to own WhatsappWeb session, it means that it will restore session if you open a new session in other browser.

On the other hand, if session is not started, it will renew QR automatically when it expires. It will save QR image each time it changes.

$ PYTHONPATH=.:$PYTHONPATH python3 examples/statemonitor.py

Get contacts

It prints contact list.

$ PYTHONPATH=.:$PYTHONPATH python3 examples/getcontacts.py

Get chats

It prints chat list.

$ PYTHONPATH=.:$PYTHONPATH python3 examples/getchats.py

Get messages

It prints message list and monitors it. So, if new messages are received it will print them. It monitors message acknowledgments and prints them, as well.

It stores files and thumbnails from media messages.

$ PYTHONPATH=.:$PYTHONPATH python3 examples/getmessages.py

Minibot

Minibot implements 4 features:

Echo

When a contact sends /echo [text] it replies with [text].

Example

/echo Hello!

Contact

When a contact sends /contact [contactID] it replies with the contact in VCard format.

Example

/contact 495555555555

Download

When a contact sends /download [url] it replies with content pointed by URL (image, pdf, video).

Example

/download http://example.com/image.jpg

Send

When a contact sends /send [contactId] [text] it will send [text] to [contactId]. [contactId] must be a phone number with country prefix: 495555555555 where 49 is Germany prefix.

Example

/send 495555555555 Hello!

$ PYTHONPATH=.:$PYTHONPATH python3 examples/minibot.py

Legal

This code is in no way affiliated with, authorized, maintained, sponsored or endorsed by WhatsApp or any of its affiliates or subsidiaries. This is an independent and unofficial software. Use at your own risk.