syndirella.DatabaseSearch
=========================

.. py:module:: syndirella.DatabaseSearch

.. autoapi-nested-parse::

   DatabaseSearch.py

   This module contains the functionality for a database search. Can do it via Postera or another database (smallworld, etc.).



Classes
-------

.. autoapisummary::

   syndirella.DatabaseSearch.DatabaseSearch


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

.. py:class:: DatabaseSearch

   Bases: :py:obj:`abc.ABC`


   This class contains information about the database search. It will perform the database search using the
   database_search_function. It will also store the results of the database search as a .csv file.


   .. py:attribute:: url
      :value: None



   .. py:attribute:: api_key
      :value: None



   .. py:method:: perform_database_search(reactant: rdkit.Chem.Mol, reaction_name: str, search_type: str)
      :abstractmethod:


      This function is used to perform the database search using the database_search_function.



   .. py:method:: get_resp_json(url: str, data: Dict = None) -> Optional[Dict]
      :abstractmethod:


      Directly get the response json from a request.



   .. py:method:: save_database_search()
      :abstractmethod:


      This function is used to save the results of the database search as a .csv file.



   .. py:method:: load_database_search()
      :abstractmethod:


      This function is used to load the results of the database search from a .csv file.