agency.cli
==========

.. py:module:: agency.cli


Attributes
----------

.. autoapisummary::

   agency.cli.cli


Functions
---------

.. autoapisummary::

   agency.cli.consolidate_cli
   agency.cli.import_bs_function
   agency.cli.import_bs_data_files
   agency.cli.import_lu_data_files
   agency.cli.create_pdf
   agency.cli.export_xlsx
   agency.cli.enable_yubikey
   agency.cli.disable_yubikey


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

.. py:data:: cli

.. py:function:: consolidate_cli(based_on: str, ignore_case: bool, dry_run: bool, verbose: bool) -> collections.abc.Callable[[onegov.agency.request.AgencyRequest, onegov.agency.app.AgencyApp], None]

   Consolidates double entries of person objects based on the property
   `based_on`. Property must be convertible to string.


.. py:function:: import_bs_function(agency_file: str, people_file: str, dry_run: bool) -> collections.abc.Callable[[onegov.agency.request.AgencyRequest, onegov.agency.app.AgencyApp], None]

.. py:function:: import_bs_data_files(agency_file: str, people_file: str, dry_run: bool, clean: bool) -> collections.abc.Callable[[onegov.agency.request.AgencyRequest, onegov.agency.app.AgencyApp], None]

   Usage:

       onegov-agency  --select /onegov_agency/bs import-bs-data         $agency_file $people_file


.. py:function:: import_lu_data_files(data_file: str, dry_run: bool, clean: bool) -> collections.abc.Callable[[onegov.agency.request.AgencyRequest, onegov.agency.app.AgencyApp], None]

   Usage:

       onegov-agency --select /onegov_agency/lu import-lu-data $people_file


.. py:function:: create_pdf(group_context: onegov.core.cli.core.GroupContext, root: bool, recursive: bool) -> collections.abc.Callable[[onegov.agency.request.AgencyRequest, onegov.agency.app.AgencyApp], None]

.. py:function:: export_xlsx(group_context: onegov.core.cli.core.GroupContext, people: bool) -> collections.abc.Callable[[onegov.agency.request.AgencyRequest, onegov.agency.app.AgencyApp], None]

.. py:function:: enable_yubikey(group_context: onegov.core.cli.core.GroupContext) -> collections.abc.Callable[[onegov.agency.request.AgencyRequest, onegov.agency.app.AgencyApp], None]

.. py:function:: disable_yubikey(group_context: onegov.core.cli.core.GroupContext) -> collections.abc.Callable[[onegov.agency.request.AgencyRequest, onegov.agency.app.AgencyApp], None]