.. _f-historyhelper:

module ``loghelper.history_helper``
===================================





.. inheritance-diagram:: pyquickhelper.loghelper.history_helper


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

module ``pyquickhelper.loghelper.history_helper``

@helper Build history for a module.


:githublink:`%|py|5`




Classes
+++++++

+-------------------------------------------------------------------------------------+---------------------------------------------------------------+
| class                                                                               | truncated documentation                                       |
+=====================================================================================+===============================================================+
| :class:`open_stream_file <pyquickhelper.loghelper.history_helper.open_stream_file>` | Opens a stream or a filename. It works with keyword ``with``. |
+-------------------------------------------------------------------------------------+---------------------------------------------------------------+




Functions
+++++++++

+--------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| function                                                                                               | truncated documentation                                                                                                 |
+========================================================================================================+=========================================================================================================================+
| :func:`build_history <pyquickhelper.loghelper.history_helper.build_history>`                           | Returns an history of a module.                                                                                         |
+--------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`compile_history <pyquickhelper.loghelper.history_helper.compile_history>`                       | Compile history and produces a :epkg:`rst` file.                                                                        |
+--------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`enumerate_closed_issues <pyquickhelper.loghelper.history_helper.enumerate_closed_issues>`       | Enumerates github issues for a repo and an owner since a given date.                                                    |
+--------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`extract_issue_from_history <pyquickhelper.loghelper.history_helper.extract_issue_from_history>` | Extracts issues from exsiting history stored in ``HISTORY.rst``. The pattern must extract from the following lines: ... |
+--------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+








Methods
+++++++

+------------------------------------------------------------------------------------------+------------------------------------+
| method                                                                                   | truncated documentation            |
+==========================================================================================+====================================+
| :py:meth:`__enter__ <pyquickhelper.loghelper.history_helper.open_stream_file.__enter__>` | Opens the stream or the file.      |
+------------------------------------------------------------------------------------------+------------------------------------+
| :py:meth:`__exit__ <pyquickhelper.loghelper.history_helper.open_stream_file.__exit__>`   | Leaves the stream or the filename. |
+------------------------------------------------------------------------------------------+------------------------------------+
| :py:meth:`__init__ <pyquickhelper.loghelper.history_helper.open_stream_file.__init__>`   |                                    |
+------------------------------------------------------------------------------------------+------------------------------------+
| :meth:`read <pyquickhelper.loghelper.history_helper.open_stream_file.read>`              | Reads some bytes.                  |
+------------------------------------------------------------------------------------------+------------------------------------+
| :meth:`readline <pyquickhelper.loghelper.history_helper.open_stream_file.readline>`      | Basic implementation.              |
+------------------------------------------------------------------------------------------+------------------------------------+
| :meth:`readlines <pyquickhelper.loghelper.history_helper.open_stream_file.readlines>`    | Basic implementation.              |
+------------------------------------------------------------------------------------------+------------------------------------+


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

.. automodule:: pyquickhelper.loghelper.history_helper
    :members:
    :special-members: __init__
    :show-inheritance: