donationmanager 2.0.0

Usage

Importing

Find the link to your API link for your donations (For help finding your link go to Donor Drive API: How tos). Import the module into your python project as normal

[!IMPORTANT] Currently the import is fairly messy, and has to be imported a little confusingly, see the example code below

Creating a new Donation Manager class

After importing the DonationTracker class can be initialized like any other python object, requiring a url to your DonorDrive donation API Link

Optionally, after the URL, a second string giving the name for the json file. The format is <PATH>/<FILENAME>.json inputting any other filetype into the method raises a TypeError

Using the get_new_donations() method

Any DonationTracker object can get the get_new_donations() method. Calling this method requests the donation Json from the Donor Drive API for the participant's link

The method calls the API, which returns JSON data. It then checks if there is already a local donos.json. The return from this method is an array of the format [number of new donations, new donations json]

The Json returned in the array is formatted as a python dictionary inside of an array this is a little strange, however it is a byproduct of Python's built-in Json Handler Module. This format allows interchangability between Json (for file handling) and usage in python. It is essential the formatting is not changed, as doing so may lead to malformed JSON file output.

An example of the output of this is as follows

[1, [{'displayName': 'Johnpaul Shields', 'donorID': '79D83C498A38FBB3', 'links': {'recipient': 'https://www.extra-life.org/participants/566838', 'donate': 'https://www.extra-life.org/participants/566838/donate'
}, 'isRegFee': False, 'eventID': 562, 'createdDateUTC': '2026-02-20T21:14:29.923Z', 'recipientName': 'Johnpaul Shields', 'recipientImageURL': 'https://donordrivecontent.com/extralife/images/$avatars$/constituen
t_E4B21B29-DD36-DBF8-79D83C498A38FBB3.jpg?v=1771442940259', 'message': 'Test Dono 2', 'participantID': 566838, 'amount': 1.0, 'donorIsRecipient': True, 'avatarImageURL': 'https://donordrivecontent.com/extralife
/images/$avatars$/constituent_E4B21B29-DD36-DBF8-79D83C498A38FBB3.jpg?v=1771442940259', 'donationID': '235890E3214394E3'}]]

The method then writes the new data to the json file allowing the method to be used again. When no new donations are given, the method returns [0, '{}'] of which '{}' is an empty json list

Using the get_last_cached_donation() method

Just like the get_new_donations() method, the get_last_cached_donation() method returns JSON data. However, it does not return an array like get_new_donations() does. Instead it returns just raw cached donation data, and if there is none it returns a '{}'. The biggest difference between this method and get_new_donations() is that get_last_cached_donation() does NOT make an API request; Instead it checks if there is already a json file with the donation data and if there is, returns the latest donation. This was added as a way to get the "cached" donation data without making an API request.

An example of the output of this method is as follows:

• If there is a file

{'displayName': 'Johnpaul Shields', 'donorID': '79D83C498A38FBB3', 'links': {'recipient': 'https://www.extra-life.org/participants/566838', 'd
onate': 'https://www.extra-life.org/participants/566838/donate'}, 'isRegFee': False, 'eventID': 562, 'createdDateUTC': '2026-02-20T21:14:29.92
3Z', 'recipientName': 'Johnpaul Shields', 'recipientImageURL': 'https://donordrivecontent.com/extralife/images/$avatars$/constituent_E4B21B29-
DD36-DBF8-79D83C498A38FBB3.jpg?v=1773862012806', 'message': 'Test Dono 2', 'participantID': 566838, 'amount': 1.0, 'donorIsRecipient': True, '
avatarImageURL': 'https://donordrivecontent.com/extralife/images/$avatars$/constituent_E4B21B29-DD36-DBF8-79D83C498A38FBB3.jpg?v=1773862012806
', 'donationID': '235890E3214394E3'}

• If there is no file

{}

Using the get_cached_donation() method

Just like the get_cached_donations() method, the get_cached_donation() method returns JSON data (not in an array) and doesn't make an API request. It takes in one argument (an integer) donation_index and returns the donation in the cached data at that index. After a recent push, get_last_cached_donation() now uses this method at donation_index of 0. If the index is not an integer or is out of bounds, the method gives an error in the standard output and returns an empty json '{}'

Example of Usage

from donationmanager import DonoTracker

url = 'https://www.extra-life.org/api/1.6/participants/minismeef/donations'
donotracker = DonoTracker.DonationTracker(url)

if __name__ == '__main__':
    new_donations = donotracker.get_new_donations()
    print(new_donations)