.. _f-pygithelper: module ``loghelper.repositories.pygit_helper`` ============================================== .. inheritance-diagram:: pyquickhelper.loghelper.repositories.pygit_helper Short summary +++++++++++++ module ``pyquickhelper.loghelper.repositories.pygit_helper`` Uses git to get version number. :githublink:`%|py|6` Classes +++++++ +----------------------------------------------------------------------------------------+----------------------------------+ | class | truncated documentation | +========================================================================================+==================================+ | :class:`GitException ` | Exception raised by this module. | +----------------------------------------------------------------------------------------+----------------------------------+ | :class:`RepoFile ` | Mimic a :epkg:`GIT` file. | +----------------------------------------------------------------------------------------+----------------------------------+ Functions +++++++++ +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | function | truncated documentation | +===========================================================================================================================+============================================================================================================================+ | :func:`__get_version_from_version_txt ` | Private function, tries to find a file ``version.txt`` which should contains the version number (if :epkg:`svn` is not ... | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`clone ` | Clones a :epkg:`git` repository. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`get_cmd_git ` | Gets the command line used to run :epkg:`git`. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`get_file_details ` | Returns information about a file. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`get_file_details_all ` | Returns information about all files | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`get_file_last_modification ` | Returns the last modification of a file. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`get_master_location ` | Gets the remote master location. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`get_nb_commits ` | Returns the number of commit. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`get_repo_log ` | Gets the latest changes operated on a file in a folder or a subfolder. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`get_repo_version ` | Gets the latest check for a specific path or version number based on the date (if *usedate* is True). If *usedate* ... | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`IsRepo ` | Says if it a repository :epkg:`GIT`. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`my_date_conversion ` | Converts a date into a datetime. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`rebase ` | Runs ``git pull -rebase`` on a repository. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :func:`repo_ls ` | Runs ``ls`` on a path. | +---------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Methods +++++++ +-------------------------------------------------------------------------------------------+-------------------------+ | method | truncated documentation | +===========================================================================================+=========================+ | :py:meth:`__init__ ` | | +-------------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`__str__ ` | usual | +-------------------------------------------------------------------------------------------+-------------------------+ Documentation +++++++++++++ .. automodule:: pyquickhelper.loghelper.repositories.pygit_helper :members: :special-members: __init__ :show-inheritance: