.. _l-functions:

Functions
=========

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


Summary
+++++++

+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| function                                                                             | class parent | truncated documentation                                                                                                          |
+======================================================================================+==============+==================================================================================================================================+
| :func:`_aggnotnan <mathenjeu.datalog.qcmlog._aggnotnan>`                             |              |                                                                                                                                  |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`_aggnotnan_serie <mathenjeu.datalog.qcmlog._aggnotnan_serie>`                 |              |                                                                                                                                  |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`_duration <mathenjeu.datalog.qcmlog._duration>`                               |              |                                                                                                                                  |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`_enumerate_processed_row <mathenjeu.datalog.qcmlog._enumerate_processed_row>` |              | Converts time, data as dictionary into other data as dictionary.                                                                 |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`_setup_hook <mathenjeu._setup_hook>`                                          |              | if this function is added to the module, the help automation and unit tests call it first before anything goes on ...            |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`build_games <mathenjeu.cli.cli_helper.build_games>`                           |              | Interprets parameters.                                                                                                           |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`check <mathenjeu.check>`                                                      |              | Checks the library is working. It raises an exception. If you want to disable the logs:                                          |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`create_qcm_https_app <mathenjeu.cli.qcm_app.create_qcm_https_app>`            |              | Creates a https web-application with https authentification.                                                                     |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`create_qcm_local_app <mathenjeu.cli.qcm_app.create_qcm_local_app>`            |              | Creates a local web-application with very simple authentification.                                                               |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`create_self_signed_cert <mathenjeu.cli.openssl.create_self_signed_cert>`      |              | Creates a signed certificate.                                                                                                    |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`create_static_https_app <mathenjeu.cli.static_app.create_static_https_app>`   |              | Creates a https web-application with https authentification.                                                                     |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`create_static_local_app <mathenjeu.cli.static_app.create_static_local_app>`   |              | Creates a local web-application with very simple authentification.                                                               |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_qcmlog <mathenjeu.datalog.qcmlog.enumerate_qcmlog>`                 |              | Processes many files of logs produced by application :class:`QCMApp`.                                                            |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_qcmlogdf <mathenjeu.datalog.qcmlog.enumerate_qcmlogdf>`             |              | Processes many files of logs produced by application :class:`QCMApp` in dataframe.                                               |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_game <mathenjeu.tests.get_game>`                                          |              | Retrieves a game.                                                                                                                |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`main <mathenjeu.__main__.main>`                                               |              | Implements ``python -m mathenjeu <command> <args>``.                                                                             |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`ml_french_qcm <mathenjeu.tests.qcms.ml_french_qcm>`                           |              | Builds a simple French :epkg:`QCM` about machine learning.                                                                       |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`name2activity <mathenjeu.cli.cli_helper.name2activity>`                       |              | Converts something like ``mathenjeu.tests.qcms.py:simple_french_qcm`` into a class name. Calls function *simple_french_qcm*. ... |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`simple_cinema_qcm <mathenjeu.tests.qcms.simple_cinema_qcm>`                   |              | Builds a simple French :epkg:`QCM` about movies.                                                                                 |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`simple_french_qcm <mathenjeu.tests.qcms.simple_french_qcm>`                   |              | Builds a simple French :epkg:`QCM` about mathématiques.                                                                          |
+--------------------------------------------------------------------------------------+--------------+----------------------------------------------------------------------------------------------------------------------------------+