swissvotes.cli
==============

.. py:module:: swissvotes.cli


Attributes
----------

.. autoapisummary::

   swissvotes.cli.cli


Functions
---------

.. autoapisummary::

   swissvotes.cli.add
   swissvotes.cli.import_attachments
   swissvotes.cli.import_campaign_material
   swissvotes.cli.reindex_attachments
   swissvotes.cli.update_resources


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

.. py:data:: cli

.. py:function:: add(group_context: onegov.core.cli.core.GroupContext) -> collections.abc.Callable[[onegov.swissvotes.request.SwissvotesRequest, onegov.swissvotes.app.SwissvotesApp], None]

   Adds an instance to the database. For example:

   .. code-block:: bash

       onegov-swissvotes --select '/onegov_swissvotes/swissvotes' add



.. py:function:: import_attachments(group_context: onegov.core.cli.core.GroupContext, folder: str) -> collections.abc.Callable[[onegov.swissvotes.request.SwissvotesRequest, onegov.swissvotes.app.SwissvotesApp], None]

   Import a attachments from the given folder. For example:

   .. code-block:: bash

       onegov-swissvotes \
           --select '/onegov_swissvotes/swissvotes' \
           import-attachments data_folder

   Expects a data folder structure with the first level representing an
   attachment and the second level a locale. The PDFs have to be named by
   BFS number (single number or range). For example:

       data/voting_text/de_CH/001.pdf
       data/voting_text/de_CH/038.1.pdf
       data/voting_text/de_CH/622-625.pdf



.. py:function:: import_campaign_material(group_context: onegov.core.cli.core.GroupContext, folder: str) -> collections.abc.Callable[[onegov.swissvotes.request.SwissvotesRequest, onegov.swissvotes.app.SwissvotesApp], None]

   Import a campaign material from the given folder. For example:

   .. code-block:: bash

       onegov-swissvotes \
           --select '/onegov_swissvotes/swissvotes' \
           import-campaign-material data_folder

   Expects all files within this folder and filenames starting with the BFS
   number. For example:

       229_Ja-PB_Argumentarium-Gründe-der-Trennung.pdf
       232-1_Nein_PB_Referentenführer.pdf



.. py:function:: reindex_attachments(group_context: onegov.core.cli.core.GroupContext) -> collections.abc.Callable[[onegov.swissvotes.request.SwissvotesRequest, onegov.swissvotes.app.SwissvotesApp], None]

   Reindexes the attachments. 


.. py:function:: update_resources(group_context: onegov.core.cli.core.GroupContext, details: bool, sa: bool, bs: bool, mfg: bool) -> collections.abc.Callable[[onegov.swissvotes.request.SwissvotesRequest, onegov.swissvotes.app.SwissvotesApp], None]

   Updates external resources.