core.cli.commands
=================

.. py:module:: core.cli.commands


Attributes
----------

.. autoapisummary::

   core.cli.commands.cli


Classes
-------

.. autoapisummary::

   core.cli.commands.SmsEventHandler
   core.cli.commands.EnhancedInteractiveConsole


Functions
---------

.. autoapisummary::

   core.cli.commands.delete
   core.cli.commands.sendmail
   core.cli.commands.sendsms
   core.cli.commands.sms_spooler
   core.cli.commands.transfer
   core.cli.commands.upgrade
   core.cli.commands.shell


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

.. py:data:: cli

.. py:function:: delete(group_context: onegov.core.cli.core.GroupContext) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Deletes a single instance matching the selector.

   Selectors matching multiple organisations are disabled for saftey reasons.



.. py:function:: sendmail(group_context: onegov.core.cli.core.GroupContext, queue: str, limit: int) -> None

   Sends mail from a specific mail queue. 


.. py:function:: sendsms(group_context: onegov.core.cli.core.GroupContext) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Sends the SMS in the smsdir for a given instance.

   For example::

       onegov-core --select '/onegov_town6/meggen' sendsms



.. py:class:: SmsEventHandler(queue_processors: list[onegov.core.sms_processor.SmsQueueProcessor])

   Bases: :py:obj:`watchdog.events.PatternMatchingEventHandler`


   Matches given patterns with file paths associated with occurring events.
   Uses pathlib's `PurePath.match()` method. `patterns` and `ignore_patterns`
   are expected to be a list of strings.


   .. py:attribute:: queue_processors


   .. py:method:: on_moved(event: watchdog.events.FileSystemEvent) -> None

      Called when a file or a directory is moved or renamed.

      :param event:
          Event representing file/directory movement.
      :type event:
          :class:`DirMovedEvent` or :class:`FileMovedEvent`



   .. py:method:: on_created(event: watchdog.events.FileSystemEvent) -> None

      Called when a file or directory is created.

      :param event:
          Event representing file/directory creation.
      :type event:
          :class:`DirCreatedEvent` or :class:`FileCreatedEvent`



.. py:function:: sms_spooler(group_context: onegov.core.cli.core.GroupContext) -> None

   Continuously spools the SMS in the smsdir for all instances using
   a watchdog that monitors the smsdir for newly created files.

   For example::

       onegov-core sms-spooler


.. py:function:: transfer(group_context: onegov.core.cli.core.GroupContext, server: str, remote_config: str, confirm: bool, no_filestorage: bool, no_database: bool, transfer_schema: str | None, add_admins: bool, delta: bool) -> None

   Transfers the database and all files from a server running a
   onegov-cloud application and installs them locally, overwriting the
   local data!

   This command expects to have access to the remote server via ssh
   (no password) and to be run sudo without password. If this is too scary
   for you, feel free to write something saner.

   Only namespaces which are present locally and remotely are considered.

   So if you have a 'cities' namespace locally and a 'towns' namespace on
   the remote, nothing will happen.

   It's also possible to transfer only a given schema, e.g. ``/town6/govikon``
   or ``/town6/*``. But beware, global files are copied in any case!

   WARNING: This may delete local content!



.. py:function:: upgrade(group_context: onegov.core.cli.core.GroupContext, dry_run: bool) -> tuple[collections.abc.Callable[Ellipsis, Any], Ellipsis]

   Upgrades all application instances of the given namespace(s). 


.. py:class:: EnhancedInteractiveConsole(locals: dict[str, Any] | None = None)

   Bases: :py:obj:`code.InteractiveConsole`


   Wraps the InteractiveConsole with some basic shell features:

   - horizontal movement (e.g. arrow keys)
   - history (e.g. up and down keys)
   - very basic tab completion


   .. py:method:: init_completer() -> None


.. py:function:: shell() -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Enters an interactive shell.