election_day.cli
================

.. py:module:: election_day.cli

.. autoapi-nested-parse::

   Provides commands used to initialize election day websites. 



Attributes
----------

.. autoapisummary::

   election_day.cli.Processor
   election_day.cli.cli


Functions
---------

.. autoapisummary::

   election_day.cli.add
   election_day.cli.fetch
   election_day.cli.send_sms
   election_day.cli.generate_media
   election_day.cli.generate_archive
   election_day.cli.update_archived_results
   election_day.cli.migrate_subscribers


Module Contents
---------------

.. py:type:: Processor
   :canonical: Callable[[ElectionDayRequest, ElectionDayApp], None]


.. py:data:: cli

.. py:function:: add(group_context: onegov.core.cli.core.GroupContext) -> Processor

   Adds an election day instance with to the database. For example:

   .. code-block:: bash

       onegov-election-day --select '/onegov_election_day/zg' add



.. py:function:: fetch(group_context: onegov.core.cli.core.GroupContext) -> Processor

   Fetches the results from other instances as defined in the
   principal.yml. Only fetches results from the same namespace.

   .. code-block:: bash

       onegov-election-day --select '/onegov_election_day/zg' fetch



.. py:function:: send_sms(group_context: onegov.core.cli.core.GroupContext, username: str, password: str, originator: str | None) -> Processor

   Sends the SMS in the smsdir for a given instance. For example:

   .. code-block:: bash

       onegov-election-day --select '/onegov_election_day/zg' \
           send_sms 'info@seantis.ch' 'top-secret'



.. py:function:: generate_media() -> Processor

   Generates the PDF and/or SVGs for the selected instances. For example:

   .. code-block:: bash

       onegov-election-day --select '/onegov_election_day/zg' generate-media



.. py:function:: generate_archive() -> Processor

   Generates a zipped file of the entire archive.

   .. code-block:: bash
       onegov-election-day --select '/onegov_election_day/zg' generate-archive


.. py:function:: update_archived_results(host: str, scheme: str) -> Processor

   Update the archive results, e.g. after a database transfer. 


.. py:function:: migrate_subscribers() -> Processor