.. _f-pysvnhelper:

module ``loghelper.repositories.pysvn_helper``
==============================================





.. inheritance-diagram:: pyquickhelper.loghelper.repositories.pysvn_helper


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

module ``pyquickhelper.loghelper.repositories.pysvn_helper``

Gather all pysvn functionalities here. There might be some differences
between SVN version, pysvn client version, TortoiseSVN version and Python.
If such a case happens, most of the function will call ``svn`` using the command line.


:githublink:`%|py|8`




Classes
+++++++

+--------------------------------------------------------------------------------+-------------------------+
| class                                                                          | truncated documentation |
+================================================================================+=========================+
| :class:`RepoFile <pyquickhelper.loghelper.repositories.pysvn_helper.RepoFile>` | mimic a svn file        |
+--------------------------------------------------------------------------------+-------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                                  | truncated documentation                                                                                                     |
+===========================================================================================================================+=============================================================================================================================+
| :func:`__get_version_from_version_txt <pyquickhelper.loghelper.repositories.pysvn_helper.__get_version_from_version_txt>` | private function, tries to find a file ``version.txt`` which should contains the version number (if svn is not present) ... |
+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`get_master_location <pyquickhelper.loghelper.repositories.pysvn_helper.get_master_location>`                       | raises an exception                                                                                                         |
+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`get_nb_commits <pyquickhelper.loghelper.repositories.pysvn_helper.get_nb_commits>`                                 | returns the number of commit                                                                                                |
+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`get_repo_log <pyquickhelper.loghelper.repositories.pysvn_helper.get_repo_log>`                                     | get the latest changes operated on a file in a folder or a subfolder                                                        |
+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`get_repo_version <pyquickhelper.loghelper.repositories.pysvn_helper.get_repo_version>`                             | get the latest check in number for a specific path                                                                          |
+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`IsRepo <pyquickhelper.loghelper.repositories.pysvn_helper.IsRepo>`                                                 | says if it a repository SVN                                                                                                 |
+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :func:`repo_ls <pyquickhelper.loghelper.repositories.pysvn_helper.repo_ls>`                                               | run ``ls`` on a path                                                                                                        |
+---------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+








Methods
+++++++

+-------------------------------------------------------------------------------------------+-------------------------+
| method                                                                                    | truncated documentation |
+===========================================================================================+=========================+
| :py:meth:`__init__ <pyquickhelper.loghelper.repositories.pysvn_helper.RepoFile.__init__>` | constructor             |
+-------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`__str__ <pyquickhelper.loghelper.repositories.pysvn_helper.RepoFile.__str__>`   | usual                   |
+-------------------------------------------------------------------------------------------+-------------------------+


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

.. automodule:: pyquickhelper.loghelper.repositories.pysvn_helper
    :members:
    :special-members: __init__
    :show-inheritance: