Overview
Zebra is a library that makes using Stripe with Django even easier.
It's made of:
zebra, the core library, with forms, webhook handlers, abstract models, mixins, signals, and templatetags that cover most stripe implementations.marty, an example app for how to integrate zebra, that also serves as its test suite.
Pull requests are quite welcome!
Usage
Installation
-
pip install django-zebra -
Edit your
settings.py:INSTALLED_APPS += ("zebra",) STRIPE_SECRET = "YOUR-SECRET-API-KEY" STRIPE_PUBLISHABLE = "YOUR-PUBLISHABLE-API-KEY" # Set any optional settings (below) -
(optional)
./manage.py syncdbif you haveZEBRA_ENABLE_APP = True -
(optional) Add in the webhook urls:
urlpatterns += patterns('', url(r'zebra/', include('zebra.urls', namespace="zebra", app_name='zebra') ), ) -
Enjoy easy billing.
Optional Settings:
ZEBRA_ENABLE_APPDefaults toFalse. Enables Customer, Plan, and Subscription django models, as a part of zebra.ZEBRA_CUSTOMER_MODELThe app+model string for the model that implements the StripeCustomerMixin. ie"myapp.MyCustomer". IfZEBRA_ENABLE_APPis true, defaults to"zebra.Customer".ZEBRA_AUTO_CREATE_STRIPE_CUSTOMERSDefaults toTrue. Automatically creates a stripe customer object on stripe_customer access, if one doesn't exist.
Webhooks
Zebra handles all the webhooks that stripe sends back and calls a set of signals that you can plug your app into. To use the webhooks:
- Include the zebra urls
- Update your stripe account to point to your webhook URL (aka https://www.mysite.com/zebra/webhooks)
- Plug into any webhook signals you care about.
Note: The initial Stripe webhook system is being deprecated. See below for a description of Zebra's support for the new system.
Zebra provides:
zebra_webhook_recurring_payment_failedzebra_webhook_invoice_readyzebra_webhook_recurring_payment_succeededzebra_webhook_subscription_trial_endingzebra_webhook_subscription_final_payment_attempt_failed
All of the webhooks provide the same arguments:
customer- ifZEBRA_CUSTOMER_MODELis set, returns an instance that matches thestripe_customer_id, orNone. IfZEBRA_CUSTOMER_MODELis not set, returnsNone.full_json- the full json response, parsed with simplejson.
So, for example, to update the customer's new billing date after a successful payment, you could:
(assuming you've set ZEBRA_CUSTOMER_MODEL or are using ZEBRA_ENABLE_APP):
from zebra.signals import zebra_webhook_recurring_payment_succeeded
def update_last_invoice_date(sender, **kwargs):
customer = kwargs.pop("customer", None)
full_json = kwargs.pop("full_json", None)
customer.billing_date = full_json.date
customer.save()
zebra_webhook_recurring_payment_succeeded.connect(update_last_invoice_date)
Webhooks Update
Stripe recently updated their webhook implementation (see https://stripe.com/blog/webhooks). Zebra includes an implementation of the new system.
- Include the zebra urls
- Update your stripe account to point to your webhook URL (aka https://www.mysite.com/zebra/webhooks/v2/)
- Plug into any webhook signals you care about.
Zebra provides:
zebra_webhook_charge_succeededzebra_webhook_charge_failedzebra_webhook_charge_refundedzebra_webhook_charge_disputedzebra_webhook_customer_createdzebra_webhook_customer_updatedzebra_webhook_customer_deletedzebra_webhook_customer_subscription_createdzebra_webhook_customer_subscription_updatedzebra_webhook_customer_subscription_deletedzebra_webhook_customer_subscription_trial_will_endzebra_webhook_customer_discount_createdzebra_webhook_customer_discount_updatedzebra_webhook_customer_discount_deletedzebra_webhook_invoice_createdzebra_webhook_invoice_updatedzebra_webhook_invoice_payment_succeededzebra_webhook_invoice_payment_failedzebra_webhook_invoiceitem_createdzebra_webhook_invoiceitem_updatedzebra_webhook_invoiceitem_deletedzebra_webhook_plan_createdzebra_webhook_plan_updatedzebra_webhook_plan_deletedzebra_webhook_coupon_createdzebra_webhook_coupon_updatedzebra_webhook_coupon_deletedzebra_webhook_transfer_createdzebra_webhook_transfer_failedzebra_webhook_ping
Zebra also provides an easy map of all the signals as zebra.signals.WEBHOOK_MAP, which maps events (charge_succeeded) to the Zebra signal (zebra_webhook_charge_succeeded). To assign a handler to all the signals that zebra sends, for example, loop over the items in the map:
for event_key, webhook_signal in WEBHOOK_MAP.iteritems():
webhook_signal.connect(webhook_logger)
Forms
The StripePaymentForm sets up a form with fields like the official stripe example.
In particular, the form is stripped of the name attribute for any of the credit card fields, to prevent accidental submission. Media is also provided to set up stripe.js (it assumes you have jQuery).
Use it in a view like so:
if request.method == 'POST':
zebra_form = StripePaymentForm(request.POST)
if zebra_form.is_valid():
my_profile = request.user.get_profile()
stripe_customer = stripe.Customer.retrieve(my_profile.stripe_customer_id)
stripe_customer.card = zebra_form.cleaned_data['stripe_token']
stripe_customer.save()
my_profile.last_4_digits = zebra_form.cleaned_data['last_4_digits']
my_profile.stripe_customer_id = stripe_customer.id
my_profile.save()
# Do something kind for the user
else:
zebra_form = StripePaymentForm()
Template Tags
There are a couple of template tags that take care of setting up the stripe env, and rendering a basic cc update form. Note that it's expected your StripePaymentForm is called either zebra_form or form.
To use in a template:
{% extends "base.html" %}{% load zebra_tags %}
{% block head %}{{block.super}}
{% zebra_head_and_stripe_key %}
{% endblock %}
{% block content %}
{% zebra_card_form %}
{% endblock %}
That's it - all the stripe tokeny goodness happens, and errors are displayed to your users.
Models and Mixins
Model and Mixin docs coming. For now, the code is pretty self-explanatory, and decently documented inline.
Other Useful Bits
Zebra comes with a manage.py command to clear out all the test customers from your account. To use it, run:
./manage.py clear_stripe_test_customers
It responds to --verbosity=[0-3].
Credits
I did not write any of stripe. It just makes me happy to use, and inspired to make better APIs for my users. For Stripe info, ask them: stripe.com
Code credits are in the AUTHORS file. Pull requests welcome!
997 Dec 24, 2022
13 Jan 10, 2022
672 Dec 22, 2022
25 May 25, 2022
37 Nov 9, 2022
68 Jan 7, 2023
4.6k Jan 5, 2023
11k Dec 30, 2022
42 Nov 25, 2022
3 Jul 5, 2022
1.3k Dec 28, 2022
1 Feb 3, 2022
139 Dec 5, 2022
2 Feb 17, 2022
18 Dec 17, 2022
1.3k Jan 3, 2023
11 Nov 20, 2022