#########
TurboVote
#########

Overview
========

`TurboVote <https://turbovote.org/>`__ 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).

.. admonition:: Authentication

   TurboVote requires `HTTP Basic Auth <https://en.wikipedia.org/wiki/Basic_access_authentication>`__.
   Clients with a TurboVote account must pass their username, password, and subdomain.

Quickstart
==========

To instantiate the :class:`~parsons.turbovote.turbovote.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.

.. code-block:: python
   :caption: Pass credentials via environmental variables

   from parsons import TurboVote
   tv = TurboVote()

.. code-block:: python
   :caption: Pass credentials as arguments

   from parsons import TurboVote
   tv = TurboVote(username='me', password='pass', subdomain='myorg')

You can then call class methods:

.. code-block:: python
   :caption: Get users

   tv.get_users()

API
====

.. autoclass:: parsons.turbovote.turbovote.TurboVote
   :inherited-members:
   :members: