fsi.cli

Attributes

cli

Functions

do_ims_import(→ None)

import_ims_data_cli(→ Callable[[FsiRequest, FsiApp], None])

correct_ims_data_cli(→ Callable[[FsiRequest, FsiApp], ...)

import_teacher_data_cli(→ Callable[[FsiRequest, ...)

test_ldap(→ None)

Examples:

fetch_users_cli(→ Callable[[FsiRequest, FsiApp], None])

Updates the list of users/course attendees by fetching matching users

fetch_users(→ None)

Implements the fetch-users cli command.

Module Contents

fsi.cli.cli[source]
fsi.cli.do_ims_import(path: str, request: onegov.fsi.request.FsiRequest) None[source]
fsi.cli.import_ims_data_cli(path: str) Callable[[FsiRequest, FsiApp], None][source]
fsi.cli.correct_ims_data_cli(path: str) Callable[[FsiRequest, FsiApp], None][source]
fsi.cli.import_teacher_data_cli(path: str, clear: bool) Callable[[FsiRequest, FsiApp], None][source]
fsi.cli.test_ldap(base: Sequence[str], search_filter: str, ldap_server: str, ldap_username: str, ldap_password: str, sort_by: str) None[source]

Examples: Search for an email: (mail=walter.roderer@zg.ch) Search for names: (&(zgXGivenName=Vorname)(zgXSurname=Nachname)) Search for mail ending in: (mail=*@phgz.ch)

onegov-fsi –select /fsi/zug test-ldap –base ‘ou=Kanton,o=KTZG’ –ldap-server ‘ldaps://…..’ –ldap-username ‘user’ –ldap-password ‘xxxx’ –search-filter “(mail=*@zg.ch)”

fsi.cli.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) Callable[[FsiRequest, FsiApp], None][source]

Updates the list of users/course attendees 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:

onegov-fsi –select /fsi/fsi fetch-users

–ldap-server ‘ldaps://1.2.3.4’ –ldap-username ‘foo’ –ldap-password ‘bar’ –admin-group ‘ou=Admins’ –editor-group ‘ou=Editors’

fsi.cli.fetch_users(app: onegov.fsi.app.FsiApp, 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, add_attendee: bool = True) None[source]

Implements the fetch-users cli command.