Reusable backend to accept & track donations to your site
Project description
Django Donations
================
.. image:: https://img.shields.io/travis/founders4schools/django-donations.svg?style=flat-square
:target: https://travis-ci.org/founders4schools/django-donations
.. image:: https://img.shields.io/coveralls/founders4schools/django-donations.svg?style=flat-square
:target: https://coveralls.io/github/founders4schools/django-donations?branch=master
.. 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://img.shields.io/requires/github/founders4schools/django-donations.svg?style=flat-square
:target: https://requires.io/github/founders4schools/django-donations/requirements/?branch=master
TODO
====
* example project/sort out config folder
* setup.py/requirements.txt
* auto_config.py/app_settings.py
* integrate with pypi, readthedocs & travis
* tests - unit/integration
* task to periodically verify pending donations
* Update the documentation and readme
(* 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
Basic Commands - Update to be correct
--------------
Test coverage
^^^^^^^^^^^^^
To run the tests, check your test coverage, and generate an HTML coverage report::
$ coverage run manage.py test
$ coverage html
$ open htmlcov/index.html
Running end to end integration tests
------------------------------------
N.B. The integration tests will not run on Windows.
To install the test runner::
$ pip install hitch
To run the tests, enter the django-donations/tests directory and run the following commands::
$ hitch init
Then run the stub test::
$ hitch test stub.test
This will download and compile python, postgres and redis and install all python requirements so the first time it runs it may take a while.
Subsequent test runs will be much quicker.
The testing framework runs Django, Celery (if enabled), Postgres, HitchSMTP (a mock SMTP server), Firefox/Selenium and Redis.
================
.. image:: https://img.shields.io/travis/founders4schools/django-donations.svg?style=flat-square
:target: https://travis-ci.org/founders4schools/django-donations
.. image:: https://img.shields.io/coveralls/founders4schools/django-donations.svg?style=flat-square
:target: https://coveralls.io/github/founders4schools/django-donations?branch=master
.. 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://img.shields.io/requires/github/founders4schools/django-donations.svg?style=flat-square
:target: https://requires.io/github/founders4schools/django-donations/requirements/?branch=master
TODO
====
* example project/sort out config folder
* setup.py/requirements.txt
* auto_config.py/app_settings.py
* integrate with pypi, readthedocs & travis
* tests - unit/integration
* task to periodically verify pending donations
* Update the documentation and readme
(* 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
Basic Commands - Update to be correct
--------------
Test coverage
^^^^^^^^^^^^^
To run the tests, check your test coverage, and generate an HTML coverage report::
$ coverage run manage.py test
$ coverage html
$ open htmlcov/index.html
Running end to end integration tests
------------------------------------
N.B. The integration tests will not run on Windows.
To install the test runner::
$ pip install hitch
To run the tests, enter the django-donations/tests directory and run the following commands::
$ hitch init
Then run the stub test::
$ hitch test stub.test
This will download and compile python, postgres and redis and install all python requirements so the first time it runs it may take a while.
Subsequent test runs will be much quicker.
The testing framework runs Django, Celery (if enabled), Postgres, HitchSMTP (a mock SMTP server), Firefox/Selenium and Redis.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
django-donations-0.1.0.tar.gz
(6.9 kB
view hashes)
Built Distribution
Close
Hashes for django_donations-0.1.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7059e619592030069e4d4cb5c4bbf31b2c554537ed7fff7e4100c92ec2b8dacb |
|
MD5 | f8de20191715de9f1d6107f92bd6e0e6 |
|
BLAKE2b-256 | e4967500e992a1f14ba5ae77fb5a511a7ab6ac1518c01ccadd61a94fd9402416 |