Welcome to Yowsup Gateway’s documentation!¶

Contents:

Yowsup Gateway¶

Yowsup Gateway pretends to be a link between yowsup library and client applications

Free software: ISC license
Documentation: https://yowsup-gateway.readthedocs.org.

Features¶

0.1.0 Send and receive text messages

Installation¶

At the moment this package uses a fork of yowsup2. While the PR is not merged it is necesary:

At the command line:

$ pip install -e git+https://github.com/jlmadurga/yowsup.git@issue_1181#egg=yowsup
$ pip install yowsup-gateway

Cloning from github:

    $ pip install -e git+https://github.com/jlmadurga/yowsup.git@issue_1181#egg=yowsup
$ git clone https://github.com/jlmadurga/yowsup-gateway.git
    $ cd yowsup-gateway
    $ make install

Usage¶

The idea of Yowsup-Gateway is simplify the use of Yowsup library.To use Yowsup Gateway in a project:

from yowsup_gateway import YowsupGateway

gateway = YowsupGateway(credentials=("phone_number", "password"))

# Send text messages
result = gateway.send_messages([("to_phone_number", "text message")])
if result.is_success:
   print result.inbox, result.outbox

# Receive messages
result = gateway.receive_messages()
if result.is_sucess:
   print result.inbox, result.outbox

If you want to use encryotion or add layers between core layers and Yowsup-Gateway layer:

gateway = YowsupGateway(credentials, True, OtherLayers)

To get whatsapp password you should register first your number with yowsup-cli https://github.com/tgalal/yowsup/wiki/yowsup-cli-2.0#yowsup-cli-registration

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/jlmadurga/yowsup_gateway/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

Yowsup Gateway could always use more documentation, whether as part of the official Yowsup Gateway docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/jlmadurga/yowsup_gateway/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up yowsup_gateway for local development.

Fork the yowsup_gateway repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/yowsup_gateway.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

$ mkvirtualenv yowsup_gateway
$ pip install -e git+https://github.com/jlmadurga/yowsup.git@issue_1181#egg=yowsup
$ cd yowsup_gateway/
$ python setup.py develop
$ pip install -r requirements_dev.txt

Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ make lint
$ make test
$ make test-all
```
To get flake8 and tox, just pip install them into your virtualenv, pip -r requirements_dev.txt

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/jlmadurga/yowsup_gateway/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_yowsup_gateway

Credits¶

Development Lead¶

Juan Madurga <jlmadurga@gmail.com>

Contributors¶

None yet. Why not be the first?

History¶

0.1.1 (2015-12-16)¶

Integration with yowsup/issue_1181.

0.1.0 (2015-12-13)¶

First release on PyPI.
Send and receive text messages