################
Mobilize America
################

Overview
========

`Mobilize America <https://join.mobilize.us/>`__ is an activist signup tool used by progressive organizations.
This class provides several methods for fetching organizations, people, and events from their
`API <https://github.com/mobilizeamerica/api/blob/main/README.md#mobilizeamerica-api>`__,
which is currently in alpha development.

.. admonition:: Authentication

   Some methods in the :class:`~parsons.mobilize_america.ma.MobilizeAmerica` class
   require an API Key furnished by Mobilize America (private methods),
   while others do not (public methods). Each method in this class contains
   a note indicating whether it is public or private. For more information, see the
   `API documentation <https://github.com/mobilizeamerica/api/blob/main/README.md#authentication>`__.

Quickstart
==========

If you instantiate :class:`~parsons.mobilize_america.ma.MobilizeAmerica` without an API Key, you can only use public methods:

.. code-block:: python
   :caption: Instantiate class without an API key

   from parsons import MobilizeAmerica
   ma = MobilizeAmerica()

.. code-block:: python
   :caption: Use public method to get all organizations

   ma.get_organizations()

In order to use private methods, you must provide an API key either by setting the environmental
variable ``MOBILIZE_AMERICA_API_KEY`` or by passing an ``api_key`` argument as shown below:

.. code-block:: python
   :caption: Instantiate class with API key as environment variable

   from parsons import MobilizeAmerica
   ma = MobilizeAmerica()

.. code-block:: python
   :caption: Instantiate class with API key as argument

   from parsons import MobilizeAmerica
   ma = MobilizeAmerica(api_key='my_api_key')

You can then call class methods requiring authentication:

.. code-block:: python
   :caption: Use private method to get all people

   ma.get_people()

API
====

.. autoclass:: parsons.mobilize_america.ma.MobilizeAmerica
   :inherited-members:
   :members: