dj-stripe

Django + Stripe Made Easy

Badges

Documentation

The full documentation is at http://dj-stripe.rtfd.org.

Features

• Subscription management
• Designed for easy implementation of post-registration subscription forms
• Single-unit purchases
• Works with Django >= 2.0
• Works with Python >= 3.4
• Compatible with Stripe API version 2018-05-21
• Built-in migrations
• Dead-Easy installation
• Leverages the best of the 3rd party Django package ecosystem
• djstripe namespace so you can have more than one payments related app
• Documented
• 100% Tested

Constraints

1. For stripe.com only
2. Only use or support well-maintained third-party libraries
3. For modern Python and Django

Quickstart

Install dj-stripe:

pip install dj-stripe

Add djstripe to your INSTALLED_APPS:

INSTALLED_APPS =(
    ...
    "djstripe",
    ...
)

Add your Stripe keys and set the operating mode:

STRIPE_LIVE_PUBLIC_KEY = os.environ.get("STRIPE_LIVE_PUBLIC_KEY", "<your publishable key>")
STRIPE_LIVE_SECRET_KEY = os.environ.get("STRIPE_LIVE_SECRET_KEY", "<your secret key>")
STRIPE_TEST_PUBLIC_KEY = os.environ.get("STRIPE_TEST_PUBLIC_KEY", "<your publishable key>")
STRIPE_TEST_SECRET_KEY = os.environ.get("STRIPE_TEST_SECRET_KEY", "<your secret key>")
STRIPE_LIVE_MODE = <True or False>

Add some payment plans via the Stripe.com dashboard or the django ORM.

Add to the urls.py:

url(r'^payments/', include('djstripe.urls', namespace="djstripe")),

Then tell Stripe about the webhook (Stripe webhook docs can be found here) using the full URL of your endpoint from the urls.py step above (e.g. https://yourwebsite.com/payments/webhook).

Run the commands:

python manage.py migrate

python manage.py djstripe_init_customers

Running the Tests

Assuming the tests are run against PostgreSQL:

createdb djstripe
pip install tox
tox

Follows Best Practices

This project follows best practices as espoused in Two Scoops of Django: Best Practices for Django 1.11.