.. _f-githelper:

module ``automation_students.git_helper``
=========================================







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

module ``ensae_teaching_cs.automation_students.git_helper``

Some automation helpers to grab mails from students about projects.


:githublink:`%|py|5`






Functions
+++++++++

+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                               | truncated documentation                                                                                                          |
+========================================================================================================================+==================================================================================================================================+
| :func:`create_folders_from_dataframe <ensae_teaching_cs.automation_students.git_helper.create_folders_from_dataframe>` | Creates a series of folders for groups of students.                                                                              |
+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_sections <ensae_teaching_cs.automation_students.git_helper.get_sections>`                                   | Extracts sections from a filename used to follow a group of students.                                                            |
+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`git_change_remote_origin <ensae_teaching_cs.automation_students.git_helper.git_change_remote_origin>`           | Changes the origin of the repository. The url and the password refer to the new repository.                                      |
+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`git_check_error <ensae_teaching_cs.automation_students.git_helper.git_check_error>`                             | Private function, analyse the output.                                                                                            |
+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`git_clone <ensae_teaching_cs.automation_students.git_helper.git_clone>`                                         | Clones a project from a git repository in a non empty local folder, it requires `GIT <http://git-scm.com/>`_ to be installed ... |
+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`git_commit_all <ensae_teaching_cs.automation_students.git_helper.git_commit_all>`                               | From a git repository, it requires `GIT <http://git-scm.com/>`_ to be installed and uses the command line.                       |
+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`git_first_commit_all_projects <ensae_teaching_cs.automation_students.git_helper.git_first_commit_all_projects>` |                                                                                                                                  |
+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :func:`git_url_user_password <ensae_teaching_cs.automation_students.git_helper.git_url_user_password>`                 | Builds a url (starting with https) and add the user and the password to skip the authentification.                               |
+------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+








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

.. automodule:: ensae_teaching_cs.automation_students.git_helper
    :members:
    :special-members: __init__
    :show-inheritance: