|
2 | 2 | django-stripe-payments |
3 | 3 | ====================== |
4 | 4 |
|
5 | | -a payments Django app for Stripe |
| 5 | +Django REST Framework wrapper of the payments Django app for Stripe |
6 | 6 |
|
| 7 | +* Forked (https://github.com/pinax/django-stripe-payments) and wrapped with Django REST Framework. |
| 8 | +* All the templates is gone |
7 | 9 |
|
8 | | -.. image:: https://img.shields.io/travis/pinax/django-stripe-payments.svg |
9 | | - :target: https://travis-ci.org/pinax/django-stripe-payments |
10 | | - |
11 | | -.. image:: https://img.shields.io/coveralls/pinax/django-stripe-payments.svg |
12 | | - :target: https://coveralls.io/r/pinax/django-stripe-payments |
13 | | - |
14 | | -.. image:: https://img.shields.io/pypi/dm/django-stripe-payments.svg |
15 | | - :target: https://pypi.python.org/pypi/django-stripe-payments/ |
16 | | - |
17 | | -.. image:: https://img.shields.io/pypi/v/django-stripe-payments.svg |
18 | | - :target: https://pypi.python.org/pypi/django-stripe-payments/ |
19 | | - |
20 | | -.. image:: https://img.shields.io/badge/license-MIT-blue.svg |
21 | | - :target: https://pypi.python.org/pypi/django-stripe-payments/ |
22 | | - |
| 10 | +Install |
| 11 | +====================== |
| 12 | +* pip install django-rest-framework-stripe |
| 13 | +* **Add to urls.py:** ``url(r"^api/stripe/", include("django_rest_framework_stripe.payments.api.urls")),`` |
23 | 14 |
|
24 | | -This app allows you to process one off charges as well as signup users for |
25 | | -recurring subscriptions managed by Stripe. |
| 15 | +Endpoints |
| 16 | +====================== |
| 17 | +* current-user/ (GET) |
| 18 | +* subscription/ (GET/POST) |
| 19 | +* change-card/ (GET/POST) |
| 20 | +* charges/ (GET) |
| 21 | +* invoices/ (GET) |
| 22 | +* plans/ (GET) |
| 23 | +* events/ (GET) |
| 24 | +* webhook/ (POST) |
| 25 | +* cancel/ (POST) |
26 | 26 |
|
27 | 27 | Documentation can be found at http://django-stripe-payments.readthedocs.org |
28 | | - |
29 | | -Some suggested integration steps: |
30 | | - 1. Overload the templates provided to use your inheritance tree (for bases etc) and block names. |
31 | | - 2. Point your stripe account at the webhook address in the payments urls. |
32 | | - 3. Add the static media snippet from here (or else nothing will actually talk to stripe): |
33 | | - * http://django-stripe-payments.readthedocs.org/en/latest/installation.html#configuration-modifications-to-settings-py |
34 | | - 4. Set up SSL if you have not already. |
35 | | - 5. Define some plans (see docs). |
36 | | - 6. Run syncdb to generate the necessary tables, then init_plans and init_customers. |
37 | | - |
38 | | -Development |
39 | | ------------ |
40 | | - |
41 | | -To run test suite:: |
42 | | - |
43 | | - $ pip install detox |
44 | | - $ detox |
0 commit comments