gazette.cli
===========

.. py:module:: gazette.cli

.. autoapi-nested-parse::

   Provides commands used to initialize gazette websites. 



Attributes
----------

.. autoapisummary::

   gazette.cli.cli


Functions
---------

.. autoapisummary::

   gazette.cli.add
   gazette.cli.import_editors
   gazette.cli.import_organizations
   gazette.cli.import_categories
   gazette.cli.import_issues
   gazette.cli.import_sogc


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

.. py:data:: cli

.. py:function:: add(group_context: onegov.core.cli.core.GroupContext) -> collections.abc.Callable[[onegov.gazette.request.GazetteRequest, onegov.gazette.app.GazetteApp], None]

   Adds a gazette instance to the database. For example:

   .. code-block:: bash

       onegov-gazette --select '/onegov_gazette/zug' add



.. py:function:: import_editors(group_context: onegov.core.cli.core.GroupContext, file: IO[bytes], clear: bool, dry_run: bool, locale: str) -> collections.abc.Callable[[onegov.gazette.request.GazetteRequest, onegov.gazette.app.GazetteApp], None]

   Imports editors and groups. For example:

   .. code-block:: bash

       onegov-gazette --select '/onegov_gazette/zug' import-editors data.xlsx



.. py:function:: import_organizations(group_context: onegov.core.cli.core.GroupContext, file: IO[bytes], clear: bool, dry_run: bool, locale: str) -> collections.abc.Callable[[onegov.gazette.request.GazetteRequest, onegov.gazette.app.GazetteApp], None]

   Imports Organizations. For example:

   .. code-block:: bash

       onegov-gazette --select '/onegov_gazette/zug' \
           import-organizations data.xlsx



.. py:function:: import_categories(group_context: onegov.core.cli.core.GroupContext, file: IO[bytes], clear: bool, dry_run: bool, locale: str) -> collections.abc.Callable[[onegov.gazette.request.GazetteRequest, onegov.gazette.app.GazetteApp], None]

   Imports categories. For example:

   .. code-block:: bash

       onegov-gazette --select '/onegov_gazette/zug' \
           import-categories data.xlsx



.. py:function:: import_issues(group_context: onegov.core.cli.core.GroupContext, file: IO[bytes], clear: bool, dry_run: bool, locale: str, timezone: str | None) -> collections.abc.Callable[[onegov.gazette.request.GazetteRequest, onegov.gazette.app.GazetteApp], None]

   Imports issues. For example:

   .. code-block:: bash

       onegov-gazette --select '/onegov_gazette/zug' import-issues data.xlsx



.. py:function:: import_sogc(group_context: onegov.core.cli.core.GroupContext, clear: bool, dry_run: bool) -> collections.abc.Callable[[onegov.gazette.request.GazetteRequest, onegov.gazette.app.GazetteApp], None]

   Imports from the SOGC. For example:

   .. code-block:: bash

       onegov-gazette --select '/onegov_gazette/zug' import-sogc