Braintree Django Module
Python
Switch branches/tags
Nothing to show
Pull request Compare This branch is 18 commits behind danielgtaylor:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
btdjango
AUTHORS
COPYING
README.md
setup.py

README.md

Braintree Django Module 1.3

This module provides an easy to use interface to Braintree using Django's built-in form system to allow Django developers to easily make use of the Braintree transparent redirect functionality to help with PCI DSS compliance issues.

The btdjango module supports all documented fields in the official transparent redirect documentation. You can selectively turn on/off fields as required by your use scenario (for example, hiding the shipping address in the transaction form).

This module depends on the Braintree Python module, so please install it first.

External Documentation

Simple Example

Download and install the btdjango module, then create a form in one of your views. Start by installing the module in settings.py:

import braintree

INSTALLED_APPS = [
    ...
    "btdjango",
    ...
]

# Braintree sandbox settings
BRAINTREE_ENV = braintree.Environment.Sandbox
BRAINTREE_MERCHANT = 'your_merchant_key'
BRAINTREE_PUBLIC_KEY = 'your_public_key'
BRAINTREE_PRIVATE_KEY = 'your_private_key'

# If you cannot install M2Crypto (e.g. AppEngine):
BRAINTREE_UNSAFE_SSL = True

Next, create a view to use one of the transparent redirect forms:

from btdjango.forms import TransactionForm

def myview(request):
    result = TransactionForm.get_result(request)

    # If successful redirect to a thank you page
    if result and result.is_success:
        return HttpResponseRedirect("/thanks")

    # Create the form. You MUST pass in the result to get error messages!
    myform = TransactionForm(result, redirect_url="http://mysite.com/myview")

    # Remove items we don't need
    myform.remove_section("transaction[shipping_address]")
    myform.remove_section("transaction[amount]")
    myform.remove_section("transaction[options]")

    # Set fields we want passed along
    myform.tr_fields["transaction"]["amount"] = "19.99"

    # Generate the tr_data signed field; this MUST be called!
    myform.generate_tr_data()

    return render("template.html", {
        "form": myform,
    })

Then, in your template rendering the form is easy:

<form action="{{ form.action }}" method="POST">
    {{ form.as_table }}
    <button type="submit">Submit order</button>
</form>

License

Braintree Django uses the MIT license. Please see the COPYING file for full details.