dj-paypal
A Paypal integration for Django, inspired by dj-stripe.
Currently only supports subscriptions.
Requirements
- Python 3.6+
- Django 3.1+
- Postgres 9.6+ (Non-postgres engines not supported)
Installation
- Install dj-paypal with
pip install dj-paypal - Add
djpaypalto djangoINSTALLED_APPSsetting - Get a client ID and client secret from paypal and add them to the settings
PAYPAL_CLIENT_IDandPAYPAL_CLIENT_SECRET - Set
PAYPAL_MODE = "sandbox"(or"live") in the settings - Install your Billing Plans (see below)
Setting up billing plans
Download already-created billing plans from Paypal
Run manage.py djpaypal_download_plans to sync all plans already created upstream
into the local database.
This will create djpaypal.models.BillingPlan objects, which can be listed from
the Django admin.
Creating new Paypal billing plans
The manage.py djpaypal_upload_plans management command creates billing plans using
the Paypal API. An extra PAYPAL_PLANS setting must be set, which will contain a dict
of Paypal billing plans to create.
See example_settings.py for an example of plans to create.
Webhooks
The djpaypal.views.ProcessWebhookView view should be hooked up to an URL endpoint
which you then set up in Paypal as a webhook endpoint (https://developer.paypal.com).
In order to verify webhooks being transmitted to your app, dj-paypal needs to know the
ID of the webhook that is expected at that URL. Set it in the setting PAYPAL_WEBHOOK_ID.
Sandbox vs. Live
All models have a livemode boolean attribute. That attribute is set to True if created
in Live (production) mode, False otherwise (sandbox mode).
Sandbox and Live data can co-exist without issues. Once you are done testing in Sandbox
mode, use the manage.py djpaypal_delete_all_test_data management command to (locally)
clear all the test data. This command has no impact on the upstream data.
Data considerations
Most of the models defined in dj-paypal are copies of the upstream Paypal model data. Deleting or editing objects (be it from the admin or in the database) does not actually change any of the upstream Paypal data.
License and Sponsorship
This project was designed and developed by HearthSim. It is licensed under the MIT license. The full license text is available in the LICENSE file.
2 maintainers
Metadata
2 maintainers
Release files for dj-paypal 0.16.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| dj_paypal-0.16.1.tar.gz | 24.9 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dj_paypal-0.16.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 62.7 kB
Release files / dj_paypal-0.16.1.tar.gz
| Download URL | dj_paypal-0.16.1.tar.gz |
|---|---|
| Size | 24.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c5610159d970841e5e3c62c0358a295c53211bcb4e2e1d7c790a1fdf7406b94c
|
|
BLAKE2b-256 checksum How to use checksums |
39c831de3715d795f57b17bbeaf44de201e80c16c0fbd3a5ebe8dffcd37cca29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 10, 2025.
Transparency logRelease files / dj_paypal-0.16.1-py3-none-any.whl
| Download URL | dj_paypal-0.16.1-py3-none-any.whl |
|---|---|
| Size | 37.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f9cecd89dcb340eb9db11a76f8b001667b3d3cd4e9edae2e1648a6463c6394b8
|
|
BLAKE2b-256 checksum How to use checksums |
85d190e19970f2c2254b2159fdc98c118f7e0fe48ff9fd505cfc521eef5b5ae3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 10, 2025.
Transparency logSecurity for dj-paypal 0.16.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for dj_paypal-0.16.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 10, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
