feriennet.app
=============

.. py:module:: feriennet.app


Attributes
----------

.. autoapisummary::

   feriennet.app.BANNER_TEMPLATE


Classes
-------

.. autoapisummary::

   feriennet.app.FeriennetApp


Functions
---------

.. autoapisummary::

   feriennet.app.get_template_directory
   feriennet.app.get_create_new_organisation_factory
   feriennet.app.get_status_mail_roles
   feriennet.app.get_ticket_manager_roles
   feriennet.app.get_public_ticket_messages
   feriennet.app.get_require_complete_userprofile
   feriennet.app.get_is_complete_userprofile_handler
   feriennet.app.get_i18n_localedirs
   feriennet.app.get_theme
   feriennet.app.get_static_directory
   feriennet.app.get_js_path
   feriennet.app.get_volunteer_cart
   feriennet.app.get_common_asset
   feriennet.app.feriennet_content_security_policy


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

.. py:data:: BANNER_TEMPLATE

.. py:class:: FeriennetApp

   Bases: :py:obj:`onegov.org.OrgApp`


   Baseclass for Morepath OneGov applications. 


   .. py:attribute:: request_class

      The class of the Request to create. Must be a subclass of
      :class:`morepath.Request`.

      By default the request class is :class:`morepath.Request`



   .. py:method:: es_may_use_private_search(request: onegov.feriennet.request.FeriennetRequest) -> bool

      Returns True if the given request is allowed to access private
      search results. By default every logged in user has access to those.

      This method may be overwritten if this is not desired.




   .. py:method:: active_period() -> onegov.activity.PeriodMeta | None


   .. py:method:: periods() -> tuple[onegov.activity.PeriodMeta, Ellipsis]


   .. py:method:: periods_by_id() -> dict[str, onegov.activity.PeriodMeta]


   .. py:method:: user_titles_by_name() -> dict[str, str]


   .. py:method:: user_ids_by_name() -> dict[str | None, uuid.UUID]


   .. py:property:: sponsors
      :type: list[onegov.feriennet.sponsors.Sponsor]



   .. py:method:: mail_sponsor(request: onegov.feriennet.request.FeriennetRequest) -> list[onegov.feriennet.sponsors.Sponsor]


   .. py:property:: default_period
      :type: onegov.activity.PeriodMeta | None



   .. py:property:: public_organiser_data
      :type: collections.abc.Sequence[str]



   .. py:method:: get_sponsors(request: onegov.feriennet.request.FeriennetRequest) -> list[onegov.feriennet.sponsors.Sponsor] | None


   .. py:method:: banners(request: onegov.feriennet.request.FeriennetRequest) -> list[dict[str, str]]


   .. py:method:: configure_organisation(*, enable_user_registration: bool = True, enable_yubikey: bool = False, disable_password_reset: bool = False, **cfg: Any) -> None


   .. py:method:: invoice_schema_config() -> tuple[str, dict[str, Any] | None]

      Returns the currently active schema_name and it's config. 



   .. py:method:: invoice_collection(period_id: uuid.UUID | None = None, user_id: uuid.UUID | None = None) -> onegov.activity.InvoiceCollection

      Returns the invoice collection guaranteed to be configured
      according to the organisation's settings.




   .. py:method:: invoice_bucket() -> str

      Returns the active invoice reference bucket. 



   .. py:property:: show_donate
      :type: bool



   .. py:property:: donation_amounts
      :type: collections.abc.Sequence[int]



   .. py:method:: show_volunteers(request: onegov.feriennet.request.FeriennetRequest) -> bool


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

.. py:function:: get_create_new_organisation_factory() -> collections.abc.Callable[[FeriennetApp, str], onegov.org.models.Organisation]

.. py:function:: get_status_mail_roles() -> collections.abc.Sequence[str]

.. py:function:: get_ticket_manager_roles() -> collections.abc.Sequence[str]

.. py:function:: get_public_ticket_messages() -> collections.abc.Sequence[str]

.. py:function:: get_require_complete_userprofile() -> bool

.. py:function:: get_is_complete_userprofile_handler() -> collections.abc.Callable[[onegov.feriennet.request.FeriennetRequest, str], bool]

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

.. py:function:: get_theme() -> onegov.feriennet.theme.FeriennetTheme

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

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

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

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

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