translator_directory.cli
========================

.. py:module:: translator_directory.cli


Attributes
----------

.. autoapisummary::

   translator_directory.cli.cli
   translator_directory.cli.LANGUAGES


Functions
---------

.. autoapisummary::

   translator_directory.cli.fetch_users
   translator_directory.cli.fetch_users_cli
   translator_directory.cli.drive_distances_cli
   translator_directory.cli.geocode_cli
   translator_directory.cli.update_accounts_cli
   translator_directory.cli.create_languages
   translator_directory.cli.force_delete_languages


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

.. py:data:: cli

.. py:function:: fetch_users(app: onegov.translator_directory.app.TranslatorDirectoryApp, session: sqlalchemy.orm.Session, ldap_server: str, ldap_username: str, ldap_password: str, admin_group: str, editor_group: str, verbose: bool = False, skip_deactivate: bool = False, dry_run: bool = False) -> None

   Implements the fetch-users cli command. 


.. py:function:: fetch_users_cli(ldap_server: str, ldap_username: str, ldap_password: str, admin_group: str, editor_group: str, verbose: bool, skip_deactivate: bool, dry_run: bool) -> collections.abc.Callable[[onegov.translator_directory.request.TranslatorAppRequest, onegov.translator_directory.app.TranslatorDirectoryApp], None]

   Updates the list of users by fetching matching users
   from a remote LDAP server.

   This is currently highly specific for the Canton of Zug and therefore most
   values are hard-coded.

   Example:
   .. code-block:: bash

       onegov-translator --select /translator_directory/zug fetch-users \
           --ldap-server 'ldaps://1.2.3.4' \
           --ldap-username 'foo' \
           --ldap-password 'bar' \
           --admin-group 'ou=Admins' \
           --editor-group 'ou=Editors'



.. py:function:: drive_distances_cli(dry_run: bool, only_empty: bool, tolerance_factor: float, max_tolerance: int, max_distance: int) -> collections.abc.Callable[[onegov.translator_directory.request.TranslatorAppRequest, onegov.translator_directory.app.TranslatorDirectoryApp], None]

.. py:function:: geocode_cli(dry_run: bool, only_empty: bool) -> collections.abc.Callable[[onegov.translator_directory.request.TranslatorAppRequest, onegov.translator_directory.app.TranslatorDirectoryApp], None]

.. py:function:: update_accounts_cli(dry_run: bool) -> collections.abc.Callable[[onegov.translator_directory.request.TranslatorAppRequest, onegov.translator_directory.app.TranslatorDirectoryApp], None]

   Updates user accounts for translators. 


.. py:data:: LANGUAGES
   :value: ('Afrikaans', 'Albanisch', 'Amharisch', 'Anyin', 'Arabisch', 'Arabisch (Dialekte)', 'Arabisch...


.. py:function:: create_languages(dry_run: bool) -> collections.abc.Callable[[onegov.translator_directory.request.TranslatorAppRequest, onegov.translator_directory.app.TranslatorDirectoryApp], None]

   Create languages for the selected translator schema. Languages get
   created if they don't exist to prevent id changes.

   This command is useful when new languages were added to the LANGUAGES list.

   NOTE: No language will be deleted. If a language is not in the LANGUAGES
   list the script will print a message.

   Example:
       onegov-translator --select /translator_directory/schaffhausen
       create-languages --dry-run


.. py:function:: force_delete_languages(dry_run: bool) -> collections.abc.Callable[[onegov.translator_directory.request.TranslatorAppRequest, onegov.translator_directory.app.TranslatorDirectoryApp], None]

   This command forcefully deletes all languages from the database and all
   references will be lost.
   This command is useful after the languages have changed and
   assigned a lot for testing.

   Example:
       onegov-translator --select /translator_directory/schaffhausen
       delete-languages --dry-run