data_source.reaction_pattern.retro_rules.utility.formatting
===========================================================

.. py:module:: data_source.reaction_pattern.retro_rules.utility.formatting

.. autoapi-nested-parse::

   The ``data_source.reaction_pattern.retro_rules.utility`` package ``formatting`` module. 



Classes
-------

.. autoapisummary::

   data_source.reaction_pattern.retro_rules.utility.formatting.RetroRulesReactionPatternDatabaseFormattingUtility


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

.. py:class:: RetroRulesReactionPatternDatabaseFormattingUtility

   The `RetroRules <https://retrorules.org>`_ chemical reaction pattern database formatting utility class. 


   .. py:method:: format_v_release(version: str, input_directory_path: Union[str, os.PathLike[str]], output_directory_path: Union[str, os.PathLike[str]]) -> None
      :staticmethod:


      Format the data from a `v_release_*` version of the database.

      :parameter version: The version of the database.
      :parameter input_directory_path: The path to the input directory where the data is extracted.
      :parameter output_directory_path: The path to the output directory where the data should be formatted.