Add interface tools

fmtr/tools/__init__.py

@@ -122,6 +122,11 @@
 except ImportError as exception:
     html = MissingExtraMockModule('html', exception)
 
+try:
+    from fmtr.tools import interface_tools as interface
+except ImportError as exception:
+    interface = MissingExtraMockModule('interface', exception)
+
 
 __all__ = [
     'config',

fmtr/tools/interface_tools.py

@@ -0,0 +1,76 @@
+from time import sleep
+
+import streamlit as st
+
+from fmtr.tools.logging_tools import logger
+
+
+class Interface:
+    """
+
+    Base for using streamlit via classes
+
+    """
+
+    PATH = __file__
+    LAYOUT = 'centered'
+    NAME = 'Base Interface'
+
+    def __init__(self, is_root=False):
+        """
+
+        Set up page layout and call loop method
+
+        """
+        logger.debug(f'Running interface loop with state: {st.session_state}...')
+
+        if is_root:
+            self.set_title()
+
+        self.loop()
+
+    def set_title(self):
+        """
+
+        Set page title and layout when root interface
+
+        """
+
+        st.set_page_config(page_title=self.NAME, layout=self.LAYOUT)
+        st.title(self.NAME)
+
+    def loop(self):
+        """
+
+        Dummy process to simulate a task
+
+        """
+
+        if not st.button('Run Test'):
+            return
+        msg = 'Running test...'
+        with st.spinner(msg):
+            sleep(3)
+        st.success("Success!")
+
+    @classmethod
+    def is_streamlit(cls):
+        """
+
+        Infer whether we are running within StreamLit
+
+        """
+        return bool(st.context.headers)
+
+    @classmethod
+    def launch(cls):
+        """
+
+        Launch StreamLit, if not already running - otherwise instantiate to run loop method
+
+        """
+        if cls.is_streamlit():
+            cls(is_root=True)
+        else:
+            from streamlit.web import bootstrap
+            bootstrap.run(cls.PATH, False, [], {})

fmtr/tools/version

@@ -1 +1 @@
-0.9.4
+0.9.5

requirements.py

@@ -27,6 +27,7 @@
     'semantic': ['sentence_transformers', 'pandas'],
     'metric': ['pandas'],
     'html': ['html2text'],
+    'interface': ['streamlit'],
 }
 
 CONSOLE_SCRIPTS = [