cobramod.parsing.db_version
===========================

.. py:module:: cobramod.parsing.db_version

.. autoapi-nested-parse::

   Database versioning configurator

   This modules includes the class DataVersionConfigurator which is in charge of
   obtaining and comparing the version from the obtained metabolic data.
   It uses the same structure of using a Singleton for the configuration in
   COBRApy



Attributes
----------

.. autoapisummary::

   cobramod.parsing.db_version.debug_log


Classes
-------

.. autoapisummary::

   cobramod.parsing.db_version.DataVersionConfigurator


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

.. py:data:: debug_log

.. py:class:: DataVersionConfigurator

   .. py:method:: get_database_version(directory)

      Loads and returns the database versioning file.

      :param directory: The folder used for storing data.
      :type directory: Path

      :returns:

                A DataFrame containing the orgid and version, at
                    the time of the first retrieval, for all databases used so far.
      :rtype: (pd.DataFrame)



   .. py:method:: get_local_databases(directory)


   .. py:method:: check_database_version(directory, database, version)

      Function to compare the saved database version with the one
      of the retrieved data.

      :param directory: The folder used for storing data.
      :type directory: Path
      :param database: Identifier of the database.
      :type database: str
      :param version: The version of the database.
      :type version: str



   .. py:method:: set_database_version(directory, database, version)

      Adds the version of a database to the local data versioning file.

      :param directory: The folder used for storing data.
      :type directory: Path
      :param database: Identifier of the database.
      :type database: str
      :param version: The version of the database.
      :type version: str

      :returns: Returns True if the addition was successful.
      :rtype: (bool)