:mod:`memote.suite.results.repo_result_manager`
===============================================

.. py:module:: memote.suite.results.repo_result_manager

.. autoapi-nested-parse::

   Provide a memote result manager that integrates with a git repository.

   ..
       !! processed by numpydoc !!



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   memote.suite.results.repo_result_manager.RepoResultManager



.. py:class:: RepoResultManager(repository, location, **kwargs)

   Bases: :class:`memote.suite.results.result_manager.ResultManager`

   Manage storage of results to JSON files.

   Results are stored to and loaded from a specific location (directory) and
   enriched with git commit meta information.















   ..
       !! processed by numpydoc !!

   .. method:: record_git_info(self, commit=None)

      Record git meta information.


      :Parameters:

          **commit** : str, optional
              Unique hexsha of the desired commit.

      :Returns:

          GitInfo
              Git commit meta information.













      ..
          !! processed by numpydoc !!


   .. method:: get_filename(self, git_info)

      Create a filename from the storage directory and the commit hash.


      :Parameters:

          **git_info** : GitInfo
              A named tuple with git meta information.

      :Returns:

          str
              The path to the file where the result of the current commit is
              stored.













      ..
          !! processed by numpydoc !!


   .. staticmethod:: add_git(meta, git_info)

      Enrich the result meta information with commit data.
















      ..
          !! processed by numpydoc !!


   .. method:: store(self, result, commit=None, **kwargs)

      Store a result in a JSON file attaching git meta information.


      :Parameters:

          **result** : memote.MemoteResult
              The dictionary structure of results.

          **commit** : str, optional
              Unique hexsha of the desired commit.

          **kwargs**
              Passed to parent function.














      ..
          !! processed by numpydoc !!


   .. method:: load(self, commit=None)

      Load a result from the storage directory.
















      ..
          !! processed by numpydoc !!