stv0g/transwhat
1
0
Fork 0
Code Issues 23 Pull requests Releases Wiki Activity
A gateway between the XMPP and the WhatsApp IM networks
311 commits 2 branches 3 tags 533 KiB
Python 93.9%
Protocol Buffer 3.4%
reStructuredText 2.7%
Find a file
Exact
Steffen Vogel 35afbe5d4a added link to transwhat group chat
2017-10-30 15:04:35 +01:00
contrib added systemd unit 2016-02-23 09:09:27 +01:00
Spectrum2 implement main method 2017-09-09 20:34:23 +02:00
transWhat Merge branch 'patch-1' of https://github.com/SmartHoneybee/transwhat into SmartHoneybee-patch-1 2017-10-29 20:31:15 +01:00
.gitignore updated gitignore 2013-08-02 01:50:09 +02:00
COPYING.rst converted all Markdown to reStructuredText because this is understood by PyPi 2017-02-11 16:45:00 -03:00
INSTALL.rst fix panda conversion 2017-10-29 16:19:06 +01:00
MANIFEST.in added setup.py for pip and easy_install 2016-04-06 21:08:29 +02:00
README.rst added link to transwhat group chat 2017-10-30 15:04:35 +01:00
setup.py remove trailing whitespace 2017-10-29 16:28:12 +01:00
USAGE.rst converted all Markdown to reStructuredText because this is understood by PyPi 2017-02-11 16:45:00 -03:00

README.rst

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

transWhat
=========

transWhat is a WhatsApp XMPP Gateway based on `Spectrum 2`_ and `Yowsup 2`_.

Support
-------

For support and discussions please join the XMPP MUC: **transwhat@conference.0l.de**.

Features
--------

-  Typing notifications
-  Receive images, audio & video
-  Set/get online status
-  Set status message
-  Groupchats

Installation
------------

transWhat requires a running and configured XMPP server.
Detailed instructions can be found on the `Installation`_ page.

Users find details on the  `Usage`_ page.

Branches
--------

-  `yowsup-1`_ My original version which is based on @tgalal first
   Yowsup version (**deprecated** and broken).
-  `yowsup-2`_ Major rewrite from @moyamo for @tgalal’s new Yowsup 2
   (**recommended**).

For production, please use the ``yowsup-2`` branch.

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:

-  @stv0g (Steffen Vogel): Idea and initial implementation based on
   Yowsup 1
-  @moyamo (Mohammed Yaseen Mowzer): Port to Yowsup 2
-  @DaZZZl: Improvements to group chats, media & message receipts

License
-------

transWhat is licensed under the GPLv3_ license.

Links
-----

-  An *outdated* project wiki is available `here`_.
-  An *outdated* writeup of this project is also availabe at my `blog`_.

.. _Spectrum 2: http://www.spectrum.im
.. _Yowsup 2: https://github.com/tgalal/yowsup
.. _yowsup-1: http://github.com/stv0g/transwhat/tree/yowsup-1
.. _yowsup-2: http://github.com/stv0g/transwhat/tree/yowsup-2
.. _Installation: INSTALL.rst
.. _Usage: USAGE.rst
.. _GPLv3: COPYING.rst
.. _here: https://dev.0l.de/wiki/projects/transwhat/
.. _blog: http://www.steffenvogel.de/2013/06/29/transwhat/