Controlshift is a platform for creating campaigns with distributed events, local groups, and member-led petitions. This connector allows you to interact with select functions of the the Controlshift Authenticated REST API .
An API Application Integration is required to instantiate the
Controlshiftclass. Details on how to create the integration and acquire credentials can be found on the Controlshift website.
To instantiate the Controlshift class, you can either store your credentials as environment
CONTROLSHIFT_CLIENT_SECRET) or pass them in as arguments:
from parsons import Controlshift # First approach: Use API credentials via environmental variables cs = Controlshift() # Second approach: Pass API credentials as arguments cs = Controlshift(hostname='my_hostname', client_id='my_client_id', client_secret='my_client_secret') # Get all petitions cs.get_petitions()
- class parsons.Controlshift(hostname=None, client_id=None, client_secret=None)
Instantiate the Controlshift class. Requires an API Application integration. For more info on setup, see: https://developers.controlshiftlabs.com/#authenticated-rest-api-quickstart-guide
- hostname: str
The URL for the homepage/login page of the organization’s Controlshift instance (e.g. demo.controlshift.app). Not required if
CONTROLSHIFT_HOSTNAMEenv variable is set.
- client_id: str
The Client ID for your REST API Application. Not required if
CONTROLSHIFT_CLIENT_IDenv variable is set.
- client_secret: str
The Client Secret for your REST API Application. Not required if
CONTROLSHIFT_CLIENT_SECRETenv variable is set.
- get_petitions() parsons.etl.table.Table
Get a full list of all petitions, including ones that are unlaunched or otherwise not visible to the public.