org.cli
=======

.. py:module:: org.cli

.. autoapi-nested-parse::

   Provides commands used to initialize org websites. 



Attributes
----------

.. autoapisummary::

   org.cli.cli


Functions
---------

.. autoapisummary::

   org.cli.add
   org.cli.import_digirez
   org.cli.fix_tags
   org.cli.close_ticket
   org.cli.fetch
   org.cli.fix_directory_files
   org.cli.migrate_town
   org.cli.migrate_links_cli
   org.cli.migrate_publications
   org.cli.delete_invisible_links


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

.. py:data:: cli

.. py:function:: 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:

   .. code-block:: bash

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



.. py:function:: 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



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

.. py:function:: close_ticket(ticket: onegov.ticket.Ticket, user: onegov.user.User, request: onegov.org.request.OrgRequest) -> None

.. py:function:: 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.

   .. code-block:: bash
       onegov-event --select '/veranstaltungen/zug' fetch \
           --source menzingen --source steinhausen \
           --published-only \
           --create-tickets \
           --state-transfers published:withdrawn \
           --state-transfers submitted:withdrawm



.. py:function:: 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'.



.. py:function:: 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.



.. py:function:: 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.


.. py:function:: 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. 


.. py:function:: 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