.. _f-staticsite:

module ``apps.staticapp.staticsite``
====================================





.. inheritance-diagram:: mathenjeu.apps.staticapp.staticsite


Short summary
+++++++++++++

module ``mathenjeu.apps.staticapp.staticsite``

Starts an application.


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                              | truncated documentation                                                                                                                                                               |
+====================================================================+=======================================================================================================================================================================================+
| :class:`StaticApp <mathenjeu.apps.staticapp.staticsite.StaticApp>` | Implements routes for a web application which serves static files protected with a password. See :ref:`Which server to server starlette application? <faq-server-app-starlette>`. ... |
+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| method                                                                                      | truncated documentation                                                                    |
+=============================================================================================+============================================================================================+
| :py:meth:`__init__ <mathenjeu.apps.staticapp.staticsite.StaticApp.__init__>`                |                                                                                            |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`cleanup <mathenjeu.apps.staticapp.staticsite.StaticApp.cleanup>`                     | Cleans up.                                                                                 |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`event <mathenjeu.apps.staticapp.staticsite.StaticApp.event>`                         | This route does not return anything interesting except a blank page, but it logs           |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`main <mathenjeu.apps.staticapp.staticsite.StaticApp.main>`                           | Defines the main page.                                                                     |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`not_found <mathenjeu.apps.staticapp.staticsite.StaticApp.not_found>`                 | Returns an :epkg:`HTTP 404` page.                                                          |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`on_error <mathenjeu.apps.staticapp.staticsite.StaticApp.on_error>`                   | An example error.                                                                          |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`page_context <mathenjeu.apps.staticapp.staticsite.StaticApp.page_context>`           | Returns the page context before applying any template.                                     |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`server_error <mathenjeu.apps.staticapp.staticsite.StaticApp.server_error>`           | Returns an :epkg:`HTTP 500` page.                                                          |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`startup <mathenjeu.apps.staticapp.staticsite.StaticApp.startup>`                     | Startups.                                                                                  |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| :meth:`unlogged_response <mathenjeu.apps.staticapp.staticsite.StaticApp.unlogged_response>` | Returns an answer for somebody looking to access the questions without being authentified. |
+---------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: mathenjeu.apps.staticapp.staticsite
    :members:
    :special-members: __init__
    :show-inheritance: