.. _l-modules:

Modules
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                      | truncated documentation                                                                                                                                                                                                |
+=============================================+========================================================================================================================================================================================================================+
| :ref:`__init__ <f-init>`                    | module ``mathenjeu``    Module *mathenjeu*.  Building an web application with QCM.      :githublink:`%|py|7`                                                                                                           |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                   | module ``mathenjeu.activities``    Shortcut to *activities*.      :githublink:`%|py|6`                                                                                                                                 |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                  | module ``mathenjeu.apps``    Shortcut to *apps*.      :githublink:`%|py|5`                                                                                                                                             |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                 | module ``mathenjeu.apps.common``    Shortcut to *common*.      :githublink:`%|py|5`                                                                                                                                    |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzz>`                | module ``mathenjeu.apps.display``    Shortcut to *display*.      :githublink:`%|py|5`                                                                                                                                  |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzz>`               | module ``mathenjeu.apps.qcm``    Shortcut to *qcm*.      :githublink:`%|py|5`                                                                                                                                          |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzz>`              | module ``mathenjeu.apps.qcm.statics``    Data coming from  `starlette-example <https://github.com/encode/starlette-example>`_.      :githublink:`%|py|6`                                                               |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzz>`             | module ``mathenjeu.apps.qcm.statics.img``    Data coming from :epkg:`wikipedia`.      :githublink:`%|py|5`                                                                                                             |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzzz>`            | module ``mathenjeu.apps.qcm.templates``    brielf More information about style can be found at  `Bootstrap style <https://v4-alpha.getbootstrap.com/components/forms/#form-layouts>`_.      :githublink:`%|py|6`       |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzzzz>`           | module ``mathenjeu.apps.server``    Shortcut to *server*.      :githublink:`%|py|5`                                                                                                                                    |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzzzzz>`          | module ``mathenjeu.apps.staticapp``    Shortcut to *srtticapp*.      :githublink:`%|py|5`                                                                                                                              |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzzzzzz>`         | module ``mathenjeu.apps.staticapp.statics``    Data coming from  `starlette-example <https://github.com/encode/starlette-example>`_.      :githublink:`%|py|6`                                                         |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzzzzzzz>`        | module ``mathenjeu.apps.staticapp.statics.img``    Data coming from :epkg:`wikipedia`.      :githublink:`%|py|5`                                                                                                       |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzzzzzzzz>`       | module ``mathenjeu.apps.staticapp.templates``    brielf More information about style can be found at  `Bootstrap style <https://v4-alpha.getbootstrap.com/components/forms/#form-layouts>`_.      :githublink:`%|py|6` |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzzzzzzzzz>`      | module ``mathenjeu.cli``    Shortcut to *cli*.      :githublink:`%|py|5`                                                                                                                                               |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzzzzzzzzzz>`     | module ``mathenjeu.datalog``    Shortcut to *datalog*.      :githublink:`%|py|6`                                                                                                                                       |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzzzzzzzzzzzzzz>`    | module ``mathenjeu.tests``    Shortcut to *tests*.      :githublink:`%|py|6`                                                                                                                                           |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__main__ <f-main>`                    | module ``mathenjeu.__main__``    Implements command line ``python -m mathenjeu <command> <args>``.      :githublink:`%|py|6`                                                                                           |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`act_question <f-actquestion>`         | module ``mathenjeu.activities.act_question``    Base classes.      :githublink:`%|py|6`                                                                                                                                |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`auth_app <f-authapp>`                 | module ``mathenjeu.apps.common.auth_app``    Starts an application.      :githublink:`%|py|6`                                                                                                                          |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`authmount <f-authmount>`              | module ``mathenjeu.apps.staticapp.authmount``    Custom Router to check for authentification.      :githublink:`%|py|5`                                                                                                |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`base_classes <f-baseclasses>`         | module ``mathenjeu.activities.base_classes``    Base classes.      :githublink:`%|py|6`                                                                                                                                |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`cli_helper <f-clihelper>`             | module ``mathenjeu.cli.cli_helper``    Helpers to interpet command line parameters.      :githublink:`%|py|5`                                                                                                          |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`html_display <f-htmldisplay>`         | module ``mathenjeu.apps.display.html_display``    Defines :epkg:`HTML` displays.      :githublink:`%|py|5`                                                                                                             |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`log_app <f-logapp>`                   | module ``mathenjeu.apps.common.log_app``    Starts an application.      :githublink:`%|py|6`                                                                                                                           |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`openssl <f-openssl>`                  | module ``mathenjeu.cli.openssl``    Starts an app locally to test it.      :githublink:`%|py|5`                                                                                                                        |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`qcm_app <f-qcmapp>`                   | module ``mathenjeu.apps.qcm.qcm_app``    Starts an application.      :githublink:`%|py|6`                                                                                                                              |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`qcm_app <f-qcmappz>`                  | module ``mathenjeu.cli.qcm_app``    Starts an app locally to test it.      :githublink:`%|py|5`                                                                                                                        |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`qcmlog <f-qcmlog>`                    | module ``mathenjeu.datalog.qcmlog``    Helpers to process data from logs.      :githublink:`%|py|6`                                                                                                                    |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`qcms <f-qcms>`                        | module ``mathenjeu.tests.qcms``    Shortcut to *tests*.      :githublink:`%|py|6`                                                                                                                                      |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`server_hypercorn <f-serverhypercorn>` | module ``mathenjeu.apps.server.server_hypercorn``    Server with :epkg:`hypercorn`.      :githublink:`%|py|5`                                                                                                          |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`static_app <f-staticapp>`             | module ``mathenjeu.cli.static_app``    Starts an app locally to test it.      :githublink:`%|py|5`                                                                                                                     |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`staticsite <f-staticsite>`            | module ``mathenjeu.apps.staticapp.staticsite``    Starts an application.      :githublink:`%|py|6`                                                                                                                     |
+---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    mathenjeu/__init__
    mathenjeu/__main__
    mathenjeu/activities/__init__
    mathenjeu/activities/act_question
    mathenjeu/activities/base_classes
    mathenjeu/apps/__init__
    mathenjeu/apps/common/__init__
    mathenjeu/apps/common/auth_app
    mathenjeu/apps/common/log_app
    mathenjeu/apps/display/__init__
    mathenjeu/apps/display/html_display
    mathenjeu/apps/qcm/__init__
    mathenjeu/apps/qcm/qcm_app
    mathenjeu/apps/qcm/statics/__init__
    mathenjeu/apps/qcm/statics/img/__init__
    mathenjeu/apps/qcm/templates/__init__
    mathenjeu/apps/server/__init__
    mathenjeu/apps/server/server_hypercorn
    mathenjeu/apps/staticapp/__init__
    mathenjeu/apps/staticapp/authmount
    mathenjeu/apps/staticapp/statics/__init__
    mathenjeu/apps/staticapp/statics/img/__init__
    mathenjeu/apps/staticapp/staticsite
    mathenjeu/apps/staticapp/templates/__init__
    mathenjeu/cli/__init__
    mathenjeu/cli/cli_helper
    mathenjeu/cli/openssl
    mathenjeu/cli/qcm_app
    mathenjeu/cli/static_app
    mathenjeu/datalog/__init__
    mathenjeu/datalog/qcmlog
    mathenjeu/tests/__init__
    mathenjeu/tests/qcms