magpie.app
==========

.. py:module:: magpie.app

.. autoapi-nested-parse::

   Magpie is a service for AuthN and AuthZ based on Ziggurat-Foundations.



Attributes
----------

.. autoapisummary::

   magpie.app.LOGGER


Functions
---------

.. autoapisummary::

   magpie.app.setup_magpie_configs
   magpie.app.main


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

.. py:data:: LOGGER

.. py:function:: setup_magpie_configs(settings: magpie.typedefs.SettingsType, db_session: Optional[sqlalchemy.orm.session.Session] = None, setup_providers: bool = True, setup_permissions: bool = True, setup_webhooks: bool = True, skip_registration: bool = False) -> None

   Resolve known configuration file paths from settings or environment variables and process them for the application.

   .. seealso::
       - https://pavics-magpie.readthedocs.io/en/latest/configuration.html#file-providers-cfg
       - https://pavics-magpie.readthedocs.io/en/latest/configuration.html#file-permissions-cfg
       - https://pavics-magpie.readthedocs.io/en/latest/configuration.html#configuration-file-formats
       - https://pavics-magpie.readthedocs.io/en/latest/configuration.html#combined-configuration-file


.. py:function:: main(global_config: Optional[magpie.typedefs.SettingsType] = None, **settings: magpie.typedefs.SettingsType) -> pyramid.router.Router

   This function returns a Pyramid WSGI application.