Welcome to Payzone Python package’s documentation!¶

Contents:

Payzone Python package¶

https://travis-ci.org/kamotos/payzone.png?branch=master

Python package for payment Payzone

Free software: BSD license
Documentation: http://payzone.readthedocs.org.

Features¶

TODO

Installation¶

At the command line:

$ easy_install payzone

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv payzone
$ pip install payzone

Usage¶

To use Payzone Python package in a project:

import payzone
client = payzone.PayZoneClient("username", "password") # Please get in touch with www.payzone.ma if you don't have the necessary credentials
response = client.transaction.prepare(**{
        'customerIP': "41.41.41.41",
        'orderID': 666,
        'amount': 15000, # 150 DH
        'shippingType': "Virtual",
        'paymentType': "CreditCard",
        'ctrlRedirectURL': "https://www.my_website.com/mycallback_uri"
})

response will be a dict containing the following elements :

customerToken
code
message
merchantToken

You might want to store this information in a database.

Right after you should redirect the user to the following url:

url = client.transaction.get_dopay_url(response['customerToken'])

Transaction status¶

In order to check a transaction status you should do the following:

client.transaction.status(merchant_token)
# the client being a PayZone instance

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/kamotos/payzone/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¶

Payzone Python package could always use more documentation, whether as part of the official Payzone Python package 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/kamotos/payzone/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 payzone for local development.

Fork the payzone repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/payzone.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 payzone
$ cd payzone/
$ python setup.py develop
```
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:
```
$ flake8 payzone tests
$ python setup.py test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

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, and 3.3, 3.4, and for PyPy. Check https://travis-ci.org/kamotos/payzone/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_payzone

Credits¶

Development Lead¶

Zahim Anass <zanass0@gmail.com>

Contributors¶

None yet. Why not be the first?

History¶

0.1.1 (2014-08-07)¶

Adding transaction capture capability

0.1.0 (2014-01-11)¶

First release on PyPI.