56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
# transWhat
|
|
|
|
transWhat is a WhatsApp XMPP Gateway based on [Spectrum 2](http://www.spectrum.im) and [Yowsup 2](https://github.com/tgalal/yowsup).
|
|
|
|
## Getting started
|
|
|
|
I assume that you have a basic understanding of XMPP and the transport concept.
|
|
transWhat is a XMPP transport. It is based on the Spectrum 2 XMPP transport framework and the Yowsup 2 library to interface with WhatsApp.
|
|
|
|
Before getting started, please make sure that you have a XMPP server running.
|
|
I am using Prosody for this.
|
|
|
|
After this we have to install several dependencies:
|
|
|
|
### Dependencies
|
|
|
|
#### Python packages
|
|
|
|
pip install --pre e4u protobuf mysql dateutil
|
|
|
|
- **e4u**: is a simple emoji4unicode python bindings
|
|
- [**yowsup**](https://github.com/tgalal/yowsup): is a python library that enables you build application which use WhatsApp service.
|
|
- **mysqldb**: MySQL client python bindings
|
|
|
|
#### Spectrum 2
|
|
|
|
Manual compile latest version from [Github](https://github.com/hanzz/libtransport).
|
|
You can use the following guide: http://spectrum.im/documentation/installation/from_source_code.html.
|
|
|
|
### Installation
|
|
|
|
git clone git@github.com:stv0g/transwhat.git
|
|
|
|
### Configuration of Prosody
|
|
|
|
http://prosody.im/doc/components
|
|
|
|
### Configuration of Spectrum
|
|
|
|
### Configuration of transWhat
|
|
|
|
## Contributors
|
|
|
|
Pull requests, bug reports etc. are welcome. Help us to provide a open implementation of the WhatsApp protocol.
|
|
|
|
The following persons have contributed major parts of this code:
|
|
|
|
- **Steffen Vogel** (@stv0g): Idea and initial implementation based on Yowsup 1
|
|
- **Mohammed Yaseen Mowzer** (@moyamo): Port to Yowsup 2
|
|
|
|
## Documentation
|
|
|
|
A project wiki is available [here](https://dev.0l.de/wiki/projects/transwhat/).
|
|
|
|
An *outdated* writeup of this project is also availabe at my [blog](http://www.steffenvogel.de/2013/06/29/transwhat/).
|