gazette.app
===========

.. py:module:: gazette.app


Classes
-------

.. autoapisummary::

   gazette.app.GazetteApp


Functions
---------

.. autoapisummary::

   gazette.app.get_static_directory
   gazette.app.get_template_directory
   gazette.app.get_theme
   gazette.app.get_i18n_localedirs
   gazette.app.get_i18n_used_locales
   gazette.app.get_i18n_default_locale
   gazette.app.get_content_security_policy
   gazette.app.get_shared_assets_path
   gazette.app.get_js_path
   gazette.app.get_css_path
   gazette.app.get_webasset_output
   gazette.app.get_frameworks_asset
   gazette.app.get_common_asset


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

.. py:class:: GazetteApp

   Bases: :py:obj:`onegov.core.Framework`, :py:obj:`onegov.file.DepotApp`, :py:obj:`onegov.quill.QuillApp`, :py:obj:`onegov.form.FormApp`, :py:obj:`onegov.user.UserApp`


   The gazette application. Include this in your onegov.yml to serve
   it with onegov-server.



   .. py:attribute:: serve_static_files
      :value: True


      Returns True if ``/static`` files should be served. Needs to be
      enabled manually.

      Note that even if the static files are not served, ``/static`` path
      is still served, it just won't return anything but a 404.

      Note also that static files are served **publicly**. You can override
      this in your application, but doing that and testing for it is on you!

      See also: :mod:`onegov.core.static`. 



   .. py:property:: principal
      :type: onegov.gazette.models.Principal


      Returns the principal of the gazette app. See
      :class:`onegov.gazette.models.principal.Principal`.




   .. py:method:: load_principal() -> onegov.gazette.models.Principal | None

      The principal is defined in the ``principal.yml`` file stored
      on the applications filestorage root.

      If the file does not exist, the site root does not exist and therefore
      a 404 is returned.

      The structure of the yaml file is defined in
      class:`onegov.gazette.model.Principal`.




   .. py:property:: logo
      :type: onegov.core.filestorage.FilestorageFile | None


      Returns the logo as
      :class:`onegov.core.filestorage.FilestorageFile`.




   .. py:method:: load_logo() -> str | None


   .. py:property:: logo_for_pdf
      :type: str | None


      Returns the SVG logo used for PDFs as string.

              



   .. py:method:: load_logo_for_pdf() -> str | None


   .. py:property:: theme_options
      :type: dict[str, str]


      Returns the application-bound theme options. 



.. py:function:: get_static_directory() -> str

.. py:function:: get_template_directory() -> str

.. py:function:: get_theme() -> onegov.gazette.theme.GazetteTheme

.. py:function:: get_i18n_localedirs() -> list[str]

.. py:function:: get_i18n_used_locales() -> set[str]

.. py:function:: get_i18n_default_locale() -> str

.. py:function:: get_content_security_policy() -> more.content_security.ContentSecurityPolicy

.. py:function:: get_shared_assets_path() -> str

.. py:function:: get_js_path() -> str

.. py:function:: get_css_path() -> str

.. py:function:: get_webasset_output() -> str

.. py:function:: get_frameworks_asset() -> collections.abc.Iterator[str]

.. py:function:: get_common_asset() -> collections.abc.Iterator[str]