agency.app
==========

.. py:module:: agency.app


Classes
-------

.. autoapisummary::

   agency.app.AgencyApp


Functions
---------

.. autoapisummary::

   agency.app.get_create_new_organisation_factory
   agency.app.get_template_directory
   agency.app.get_template_variables
   agency.app.get_theme
   agency.app.get_usergroup_form_class
   agency.app.get_i18n_localedirs
   agency.app.get_ticket_manager_roles
   agency.app.get_disabled_extensions
   agency.app.get_webasset_output
   agency.app.get_js_path
   agency.app.get_people_select_asset
   agency.app.get_sortable_multi_checkbox_asset
   agency.app.get_redactor_asserts
   agency.app.get_editor_assets
   agency.app.get_api_endpoints


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

.. py:class:: AgencyApp

   Bases: :py:obj:`onegov.org.OrgApp`, :py:obj:`onegov.api.ApiApp`


   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:property:: filestorage
      :type: fs.base.SubFS[fs.base.FS]


      Returns a filestorage object bound to the current application.
      Based on this nifty module:

      `<https://docs.pyfilesystem.org/en/latest/>`_

      The file storage returned is guaranteed to be independent of other
      applications (the scope is the application_id, not just the class).

      There is no guarantee as to what file storage backend is actually used.
      It's quite possible that the file storage will be somewhere online
      in the future (e.g. S3).

      Therefore, the urls for the file storage should always be acquired
      through :meth:`onegov.core.request.CoreRequest.filestorage_link`.

      The backend is configured through :meth:`configure_application`.

      For a list of methods available on the resulting object, consult this
      list: `<https://docs.pyfilesystem.org/en/latest/interface.html>`_.

      If no filestorage is available, this returns None.
      See :attr:`self.has_filestorage`.

      WARNING: Files stored in the filestorage are available publicly! All
      someone has to do is to *guess* the filename. To get an unguessable
      filename use :meth:`onegov.core.filestorage.random_filename`.

      The reason for this is the fact that filestorage may be something
      external in the future.

      This should not deter you from using this for user uploads, though
      you should be careful. If you want to be sure that your application
      stores files locally, use some other ways of storing those files.

      Example::

          from onegov.core import filestorage

          filename = filestorage.random_filename()
          app.filestorage.writetext(filename, 'Lorem Ipsum')

          # returns either an url like '/files/4ec56cc005c594880a...'
          # or maybe 'https://amazonaws.com/onegov-cloud/32746/220592/q...'
          request.filestorage_link(filename)




   .. py:property:: root_pdf_exists
      :type: bool



   .. py:property:: people_xlsx_exists
      :type: bool



   .. py:property:: root_pdf_modified
      :type: datetime.datetime | None



   .. py:property:: people_xlsx_modified
      :type: datetime.datetime | None



   .. py:property:: root_pdf
      :type: bytes | None



   .. py:property:: people_xlsx
      :type: bytes | None



   .. py:property:: pdf_class
      :type: type[onegov.agency.pdf.AgencyPdfDefault]



   .. py:property:: enable_yubikey
      :type: bool



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

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

.. py:function:: get_template_variables(request: onegov.agency.request.AgencyRequest) -> onegov.core.types.RenderData

.. py:function:: get_theme() -> onegov.agency.theme.AgencyTheme

.. py:function:: get_usergroup_form_class() -> type[onegov.agency.forms.UserGroupForm]

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

.. py:function:: get_ticket_manager_roles() -> tuple[str, Ellipsis]

.. py:function:: get_disabled_extensions() -> tuple[str, Ellipsis]

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

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

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

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

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

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

.. py:function:: get_api_endpoints() -> list[type[onegov.api.ApiEndpoint[Any]]]