TurboVote

Overview

TurboVote is an online voter registration and vote by mail tool. This class contains a single method which allows you to export your users (aka signups).

Note

Authentication
TurboVote requires HTTP Basic Auth. Clients with a TurboVote account must pass their username, password, and subdomain.

QuickStart

To instantiate the TurboVote class, you can either store your TurboVote API username, password, subdomain as environmental variables (TURBOVOTE_USERNAME, TURBOVOTE_PASSWORD, and TURBOVOTE_SUBDOMAIN, respectively) or pass them in as arguments:

from parsons import TurboVote

# First approach: Pass credentials via environmental variables.
tv = TurboVote()

# Second approach: Pass credentials as arguments.
tv = TurboVote(username='me', password='pass', subdomain='myorg')

You can then call the method:

# Get users
tv.get_users()

API

class parsons.TurboVote(username=None, password=None, subdomain=None)[source]

Instantiate the TurboVote class

Args:
username: str
A valid TurboVote username. Not required if TURBOVOTE_USERNAME env variable set.
password: str
A valid TurboVote password. Not required if TURBOVOTE_PASSWORD env variable set.
subdomain: str
Your TurboVote subdomain (i.e. https://MYORG.turbovote.org). Not required if TURBOVOTE_SUBDOMAIN env variable set.
Returns:
class
get_users()[source]

Get users.

Returns:
Parsons Table
See Parsons Table for output options.