Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Reusable django app to receive & track donations on charitable sites

Project Description
================
Django Donations
================

.. image:: https://travis-ci.org/founders4schools/django-donations.svg?branch=master
:target: https://travis-ci.org/founders4schools/django-donations
:alt: Build

.. image:: https://codecov.io/gh/founders4schools/django-donations/branch/master/graph/badge.svg
:target: https://codecov.io/gh/founders4schools/django-donations
:alt: Coverage

.. image:: https://landscape.io/github/founders4schools/django-donations/master/landscape.svg?style=flat-square
:target: https://landscape.io/github/founders4schools/django-donations/master
:alt: Code Health

.. image:: https://pyup.io/repos/github/founders4schools/django-donations/shield.svg
:target: https://pyup.io/repos/github/founders4schools/django-donations/
:alt: Updates

.. image:: https://pyup.io/repos/github/founders4schools/django-donations/python-3-shield.svg
:target: https://pyup.io/repos/github/founders4schools/django-donations/
:alt: Python 3

.. image:: https://badge.fury.io/py/django-donations.svg
:target: https://badge.fury.io/py/django-donations
:alt: PyPI package

Reusable django app to receive & track donations on charitable sites

Documentation
-------------

The full documentation is at https://django-donations.readthedocs.io.

Quickstart
----------

Install Django Donations::

pip install django-donations

Add it to your `INSTALLED_APPS`:

.. code-block:: python

INSTALLED_APPS = (
...
'donations.apps.DonationsConfig',
...
)

Add Django Donations's URL patterns:

.. code-block:: python

from donations import urls as donations_urls


urlpatterns = [
...
url(r'^', include(donations_urls)),
...
]

Just Giving Configuration
-------------------------

The app needs to be configured with your JustGiving API settings:

.. code-block:: python

# Ability to point to Production or Sandbox URLs
JUST_GIVING_WEB_URL = 'http://v3-sandbox.justgiving.com'
JUST_GIVING_API_URL = 'http://api-sandbox.justgiving.com'
# Replace below with your personal details
JUST_GIVING_CHARITY_ID = '123456'
JUST_GIVING_APP_ID = 'changeme'
# Add a list of all the currencies you need to support
CURRENCIES = ['GBP']

TODO
----

* Update the documentation and readme
* integrate with readthedocs or pythonhosted or both!
* tests - unit/integration
* task to periodically verify pending donations

(* dashboard - track/view donations from the business side - kpis etc
* views/urls? - provide an api hook into the system (/donations - dashboard))

v2 and beyond
-------------

* (other providers (paypal etc))
* tasks.py - recurring donation handling - this is not possible right now as SDI is not an API to be automated

Supported Providers
-------------------

* Just Giving SDI

Credits
-------

Tools used in rendering this package:

* Cookiecutter_
* `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage




History
-------

0.6.2 (2017-06-09)
++++++++++++++++++

* Add `on_delete=models.CASCADE` on foreign keys for Django 2.0

0.6.1 (2017-06-08)
++++++++++++++++++

* Python 3: fix app name as bytes in migrations
* Django 1.11 compatibility

0.6.0 (2017-01-30)
++++++++++++++++++

* Clean-up references to `django-timedeltafield` (`#9`_). This required to squash
the existing migrations. Make sure that you migrated to 0.5.0 first and
applied all migrations everywhere.
* Fix test setup. Now Django 1.10 is officially supported.

.. _#9: https://github.com/founders4schools/django-donations/issues/9

0.5.0 (2017-01-27)
++++++++++++++++++

* Migrate to Django's `DurationField` (`#8`_). You need to upgrade your
`DONATION_FREQUENCIES` setting. Values should now be python `timedelta`.

.. _#8: https://github.com/founders4schools/django-donations/issues/8

0.4.0 (2017-01-27)
++++++++++++++++++

* Fix bug with urllib import on Python 3 `#4`_
* Remove dependency on `django-autoconfig`
* Regenerate with cookie cutter for Django standalone app, resulting in:
* Cleanup a few unused files
* Remove the example project which isn't kept up to date
* Add a changelog
* Switch testing to use tox
* Switch from coveralls to codecov.io
* Test views

.. _#4: https://github.com/founders4schools/django-donations/issues/4

0.3.0 (2016-10-20)
++++++++++++++++++

* Drop support for Django 1.6 and 1.7
* Support Django 1.9
* Prepare Django 1.10

0.2.7 (2015-12-17)
++++++++++++++++++

* Add the app config for Django 1.7+

0.2.6 (2015-12-07)
++++++++++++++++++

* Some Python 3 compatibilty fixes
* Prepare for Django 1.9 compatibility

0.2.5 (2015-11-23)
++++++++++++++++++

* Django 1.8 compatibility
* Fix a few issues with Python 3

0.2.4 (2015-11-12)
++++++++++++++++++

* Doc improvements
* Django 1.7 compatibility

0.2.3 (2015-10-23)
++++++++++++++++++

* Fix a crash with anonymous donor

0.2.2 (2015-10-22)
++++++++++++++++++

* Mostly tests improvements

0.2.0 (2015-10-19)
++++++++++++++++++

* Fix various unicode crashes
* Fix that prevented the server from starting when config was being
loaded before the tables were created.
* Capture Donor name from JustGiving

0.1.3 (2016-10-16)
++++++++++++++++++

* Fix a Unicode crash in models and providers
* Revert erroneous change in `setup.py`

0.1.2 (2015-10-16)
++++++++++++++++++

* Admin improvements
* Installation fixes

0.1.1 (2015-10-13)
++++++++++++++++++

* Fix packaging on PyPI
* Docs improvements

0.0.2 (2015-10-12)
++++++++++++++++++

* Squash South migrations
* Autoconfig enhancements

0.0.1 (2015-10-12)
++++++++++++++++++

* First release on PyPI.
Release History

Release History

This version
History Node

0.6.2

History Node

0.6.1

History Node

0.6.0

History Node

0.5.0

History Node

0.4.0

History Node

0.3.0

History Node

0.2.7

History Node

0.2.6

History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.0

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django_donations-0.6.2-py2.py3-none-any.whl (18.7 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Jun 9, 2017
django-donations-0.6.2.tar.gz (16.9 kB) Copy SHA256 Checksum SHA256 Source Jun 9, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting