forked from move-coop/parsons
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Update TurboVote (move-coop#376)
* Update docs. * Fix class import. * Remove incorrect docs.
- Loading branch information
Showing
2 changed files
with
37 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,41 @@ | ||
TurboVote | ||
========= | ||
|
||
`TurboVote <https://turbovote.org/>`_ is an online registration tool used by progressive organizations. | ||
`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). | ||
|
||
.. autoclass :: parsons.turbovote.turbovote.TurboVote | ||
.. note:: | ||
Authentication | ||
TurboVote requires `HTTP Basic Auth <https://en.wikipedia.org/wiki/Basic_access_authentication>`_. | ||
Clients with a TurboVote account must pass their subdomain, username, and password. | ||
|
||
********** | ||
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: | ||
|
||
.. code-block:: python | ||
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: | ||
|
||
.. code-block:: python | ||
# Get users | ||
tv.get_users() | ||
.. autoclass :: parsons.TurboVote | ||
:inherited-members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters