swissvotes.app
==============

.. py:module:: swissvotes.app


Classes
-------

.. autoapisummary::

   swissvotes.app.SwissvotesApp


Functions
---------

.. autoapisummary::

   swissvotes.app.get_static_directory
   swissvotes.app.get_template_directory
   swissvotes.app.get_theme
   swissvotes.app.get_i18n_localedirs
   swissvotes.app.get_i18n_used_locales
   swissvotes.app.get_i18n_default_locale
   swissvotes.app.org_content_security_policy
   swissvotes.app.get_shared_assets_path
   swissvotes.app.get_js_path
   swissvotes.app.get_css_path
   swissvotes.app.get_webasset_output
   swissvotes.app.get_frameworks_asset
   swissvotes.app.get_common_asset
   swissvotes.app.get_mastodon_asset
   swissvotes.app.get_stats_asset


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

.. py:class:: SwissvotesApp

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


   The swissvotes 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.swissvotes.models.Principal



   .. py:property:: static_content_pages
      :type: set[str]



   .. py:method:: get_cached_dataset(format: Literal['csv']) -> str
                  get_cached_dataset(format: Literal['xlsx']) -> bytes

      Gets or creates the dataset in the requested format.

      We store the dataset using the last modified timestamp - this way, we
      have a version of past datasets. Note that we don't delete any old
      datasets.




   .. py:method:: configure_mfg_api_token(*, mfg_api_token: str | None = None, **cfg: Any) -> None

      Configures the Museum für Gestaltung API Token. 



   .. py:method:: configure_bs_api_token(*, bs_api_token: str | None = None, **cfg: Any) -> None

      Configures the Plakatsammlung Basel API Token. 



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

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

.. py:function:: get_theme() -> onegov.swissvotes.theme.SwissvotesTheme

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

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

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

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

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

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