.. _f-projectsrepository: module ``automation_students.projects_repository`` ================================================== .. inheritance-diagram:: ensae_teaching_cs.automation_students.projects_repository Short summary +++++++++++++ module ``ensae_teaching_cs.automation_students.projects_repository`` Some automation helpers to grab mails from students about their projects. :githublink:`%|py|5` Classes +++++++ +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +============================================================================================================+============================================================================================================================+ | :class:`ProjectsRepository ` | Handle a repository of students projects. See example :ref:`sphx_glr_automation_fetch_student_projects_from_gmail.py`. ... | +------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Properties ++++++++++ +----------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | property | truncated documentation | +==========================================================================================================+=================================================+ | :meth:`Groups ` | Returns all available groups in the repository. | +----------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | :meth:`Location ` | | +----------------------------------------------------------------------------------------------------------+-------------------------------------------------+ Static Methods ++++++++++++++ +----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ | staticmethod | truncated documentation | +====================================================================================================================================================+====================================================================+ | :meth:`create_folders_from_dataframe ` | Creates a series of folders for groups of students. | +----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ | :meth:`get_regex ` | Retrieves data from file ``suivi.rst`` using a regular expression. | +----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ | :meth:`match_mail ` | Tries to match a name among a list of mails. | +----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ | :meth:`match_mails ` | Tries to match a series of names among a list of mails. | +----------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ Methods +++++++ +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +====================================================================================================================================+========================================================================================================================+ | :py:meth:`__init__ ` | Location of the repository. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`convert_files ` | Converts all notebooks and python scripts into :epkg:`HTML` for a group. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`dump_group_mails ` | Enumerates all mails sent by or sent to a given group. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_group_files ` | Enumerates all files in a group. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_group_mails ` | Enumerates all mails sent by or sent to a given group. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_emails ` | Retrieves student emails from file ``suivi.rst``. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_group_location ` | Returns the local folder associated to a group. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_sections ` | Extracts sections from a filename used to follow a group of students. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_videos ` | Retrieves student emails from file ``suivi.rst``. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`list_mails ` | Returns the number of mails of a group. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`remove_group ` | Removes a group. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`unzip_convert ` | Unzips files and convert notebooks into :epkg:`HTML`. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`unzip_files ` | Unzips files and convert notebooks into :epkg:`HTML`. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_run_command ` | Writes a command script to run a server for this local content. The server runs the javascripts fetching for local ... | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`write_summary ` | Produces a summary and uses a :epkg:`Jinja2` template. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`zip_group ` | Zips a group. | +------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: ensae_teaching_cs.automation_students.projects_repository :members: :special-members: __init__ :show-inheritance: