org.cli

Provides commands used to initialize org websites.

Attributes

cli

Functions

add(...)	Adds an org with the given name to the database. For example:
import_digirez(...)	Imports a Digirez reservation database into onegov.org.
fix_tags(...)
close_ticket(→ None)
fetch(...)	Fetches events from other instances.
fix_directory_files(...)	Not sure of this doubles the files, but actually the file
migrate_town(...)	Migrates the database from an old town to the new town like in the
migrate_links_cli(...)	Migrates url's in pages. Supports domains and full urls. Most of
migrate_publications(...)	Marks signed files for publication.
delete_invisible_links(...)	Deletes all the data associated with a period, including:
get_resources_and_forms(...)	Get the resources and forms from the option file.
import_reservations(...)	Imports reservations from a Excel file (needs to be .xlsx).
mtan_statistics(...)	Generate mTAN SMS statistics for the given year and month.

Module Contents

org.cli.cli

org.cli.add(group_context: onegov.core.cli.core.GroupContext, name: str, locale: str) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Adds an org with the given name to the database. For example:

onegov-org --select '/onegov_org/evilcorp' add "Evilcorp"

org.cli.import_digirez(accessdb: str, min_date: str, ignore_booking_conflicts: bool) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Imports a Digirez reservation database into onegov.org.

Example: .. code-block:: bash

onegov-org –select ‘/orgs/govikon’ import-digirez room_booking.mdb

org.cli.fix_tags(group_context: onegov.core.cli.core.GroupContext, dry_run: bool) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

org.cli.close_ticket(ticket: onegov.ticket.Ticket, user: onegov.user.User, request: onegov.org.request.OrgRequest) → None

org.cli.fetch(group_context: onegov.core.cli.core.GroupContext, source: collections.abc.Sequence[str], tag: collections.abc.Sequence[str], location: collections.abc.Sequence[str], create_tickets: bool, state_transfers: collections.abc.Sequence[str], published_only: bool, delete_orphaned_tickets: bool) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Fetches events from other instances.

Only fetches events from the same namespace which have not been imported themselves.

Example .. code-block:: bash

onegov-org –select ‘/veranstaltungen/zug’ fetch

–source menzingen –source steinhausen –tag Sport –tag Konzert –location Zug

Additional parameters:

• --state-transfers published:withdrawn

  Will update the local event.state from published to withdrawn automatically. If there are any tickets associated with the event, the will be closed automatically.

• --pusblished-only

  When passing the remote items to the EventCollection, only add events if they are published.

• --delete-orphaned-tickets

  Delete Tickets, TicketNotes and TicketMessasges if an event gets deleted automatically.

The following example will close tickets automatically for submitted and published events that were withdrawn on the remote.

org.cli.fix_directory_files(group_context: onegov.core.cli.core.GroupContext) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Not sure of this doubles the files, but actually the file reference remains, so it shouldn’t

This command will become obsolete as soon as the type of files in submissions are set correctly with type ‘directory’.

org.cli.migrate_town(group_context: onegov.core.cli.core.GroupContext) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Migrates the database from an old town to the new town like in the upgrades.

org.cli.migrate_links_cli(group_context: onegov.core.cli.core.GroupContext, old_uri: str, dry_run: bool) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Migrates url’s in pages. Supports domains and full urls. Most of the urls are located in meta and content fields.

org.cli.migrate_publications(group_context: onegov.core.cli.core.GroupContext, dry_run: bool) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Marks signed files for publication.

org.cli.delete_invisible_links() → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Deletes all the data associated with a period, including:

Example: .. code-block:: bash

onegov-org –select /foo/bar delete-invisible-links

org.cli.get_resources_and_forms(option_file: IO[bytes]) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Get the resources and forms from the option file.

org.cli.import_reservations(reservation_file: IO[bytes], option_file: IO[bytes], mapping_yaml: IO[bytes], dry_run: bool) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Imports reservations from a Excel file (needs to be .xlsx). Creates no resources or allocations, so the availabilty periods need to be set in the resource settings.

org.cli.mtan_statistics(group_context: onegov.core.cli.core.GroupContext, year: int, month: int) → collections.abc.Callable[[onegov.org.request.OrgRequest, onegov.org.app.OrgApp], None]

Generate mTAN SMS statistics for the given year and month.