Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 1.78 KB

actblue.rst

File metadata and controls

52 lines (36 loc) · 1.78 KB
Raw

ActBlue

Overview

The ActBlue class allows you to interact with the ActBlue CSV API. Users of this Parsons integration can generate CSVs and manipulate entity CSV data within the Parsons table format.

Note

Authentication
In order to use this class you must generate and use a Client UUID and Client Secret set of credentials. Instructions for generating the set of keys can be found within the CSV API documentation.

Quickstart

To instantiate the ActBlue class, you can either store your ACTBLUE_CLIENT_UUID and ACTBLUE_CLIENT_SECRET keys as environment variables or pass them in as arguments:

from parsons import ActBlue

# First approach: Use API key environment variables

# In bash, set your environment variables like so:
# export ACTBLUE_CLIENT_UUID='MY_UUID'
# export ACTBLUE_CLIENT_SECRET='MY_SECRET'
actblue = ActBlue()

# Second approach: Pass API keys as arguments
actblue = ActBlue(actblue_client_uuid='MY_UUID', actblue_client_secret='MY_SECRET')

You can then make a request to generate a CSV and save its data to a Parsons table using the main helper method, get_contributions():

# Create Parsons table with entity CSV data
parsons_table = actblue.get_contributions(csv_type='paid_contributions', date_range_start='2020-01-01', date_range_end='2020-02-01')

The above example shows how to create a Parsons table with paid contribution data of your entity for the month of January 2020. In addition to 'paid_contributions', the other options for csv_type are 'refunded_contributions' and 'managed_form_contributions'.

API

.. autoclass :: parsons.ActBlue
   :inherited-members: