a3x/transpub
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
WIP
326 commits 2 branches 3 tags 538 KiB
Python 96.5%
reStructuredText 3.4%
Lua 0.1%
Go to file
Steffen Vogel 2ec730020f fixes for Python 3
2019-04-25 22:41:45 +02:00
contrib added systemd unit 2016-02-23 09:09:27 +01:00
transWhat fixes for Python 3 2019-04-25 22:41:45 +02: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 remove e4u dependency as it supports Python 2 only 2019-04-25 21:23:19 +02:00
README.rst update README.rst 2019-04-25 19:23:08 +02:00
setup.py remove unused dependency 2019-04-25 22:40:23 +02: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 3`_.

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.
-  `yowsup-3`_ Update to @tgalal’s new Yowsup 3
   (**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 3: 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
.. _yowsup-3: http://github.com/stv0g/transwhat/tree/yowsup-3
.. _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/