fmtr.tools 1.0.30__py3-none-any.whl → 1.0.32__py3-none-any.whl

fmtr/tools/api_tools.py

@@ -83,6 +83,11 @@ class ApiBase:
 
     @classmethod
     def launch(cls):
+        """
+
+        Initialise self and launch.
+
+        """
         self = cls()
         logger.info(f'Launching API {cls.TITLE}...')
         uvicorn.run(self.app, host=self.HOST, port=self.PORT)

fmtr/tools/interface_tools.py

@@ -1,218 +1,64 @@
-from time import sleep
-from typing import ClassVar
+import flet as ft
+from flet.core.event import Event
+from flet.core.types import AppView
+from flet.core.view import View
 
-from fmtr.tools.data_modelling_tools import Base
 from fmtr.tools.logging_tools import logger
-from fmtr.tools.path_tools import Path
 
 
-def material(name):
+class Interface:
     """
 
-    Get Material Design icon markdown
+    Simple interface base class.
 
     """
-    return f":material/{name}:"
+    TITLE = 'Base Interface'
+    HOST = '0.0.0.0'
+    PORT = 8080
+    APPVIEW = AppView.WEB_BROWSER
+    PATH_ASSETS = None
+    ROUTE_ROOT = '/'
 
-
-def color(name, text):
-    """
-
-    Get markdown coloured text
-
-    """
-    return f":{name}[{text}]"
-
-
-def get_streamlit():
-    import streamlit
-    return streamlit
-
-class Interface(Base):
-    """
-
-    Base for using streamlit via classes
-
-    """
-
-    PATH: ClassVar = __file__
-    LAYOUT: ClassVar = 'centered'
-    NAME: ClassVar = None
-    IS_ASYNC: ClassVar = False
-
-    parent: Base = None
-
-    @property
-    def st(self):
-        return get_streamlit()
-
-    @classmethod
-    def get_name(cls):
-        return cls.NAME or cls.__name__
-
-    def set_title(self):
-        """
-
-        Set page title and layout when root interface
-
-        """
-
-        self.st.set_page_config(page_title=self.get_name(), layout=self.LAYOUT)
-        self.st.title(self.get_name())
-
-    def render(self):
-        """
-
-        Render the Interface
-
-        """
-        raise NotImplementedError()
-
-    def get_key(self, seg=None):
-        """
-
-        Get a structure-friendly unique ID
-
-        """
-
-        suffix = f'{self.__class__.__name__}({self.get_key_self()})'
-
-        if self.parent is None:
-            base = Path(suffix)
-        else:
-            base = self.parent.get_key() / suffix
-
-        if seg:
-            path = base / seg
-        else:
-            path = base
-
-        return path
-
-    def get_url_data(self):
-        """
-
-        Get URL params data pertaining to the current object
-
-        """
-
-        if self.parent is None:
-            data = {}
-        else:
-            data = self.parent.get_url_data()
-
-        url_self = self.get_url_self()
-
-        if url_self:
-            data |= {self.__class__.__name__.lower(): url_self}
-
-        return data
-
-    def get_url_self(self):
-        """
-
-        Get URL params ID pertaining to the current object
-
-        """
-        return str(id(self))
-
-    def get_key_self(self):
+    def render(self, page: ft.Page):
         """
 
-        Get a streamlit key pertaining to the current object
-
-        """
-        return str(id(self))
+        Interface entry point.
 
-    def get_url(self):
         """
 
-        Get URL string suffix pertaining to the current object
+        if not page.on_route_change:
+            page.on_route_change = lambda e, page=page: self.route(page, e)
+            page.on_view_pop = lambda view, page=page: self.pop(page, view)
 
-        """
-        import urllib
-        return urllib.parse.urlencode(self.get_url_data())
+            page.go(self.ROUTE_ROOT)
 
-    def to_tabs(self, *classes):
+    def route(self, page: ft.Page, event: Event):
         """
 
-        Add tabs from a list of interface classes
+        Overridable router.
 
         """
-        tab_names = [cls.get_name() for cls in classes]
-        tabs = st.tabs(tab_names)
-
-        for cls, tab in zip(classes, tabs):
-            with tab:
-                cls()
+        raise NotImplementedError
 
-    @classmethod
-    def is_streamlit(cls):
+    def pop(self, page: ft.Page, view: View):
         """
 
-        Infer whether we are running within StreamLit
+        Overridable view pop.
 
         """
-        return bool(get_streamlit().context.headers)
-
-    @classmethod
-    def get_state(cls):
-        """
-
-        Initialise this Interface and keep cached. This needs to be a cached_resource to avoid serialisation/copying.
-        This is global, so session handling needs to happen downstream.
-
-        """
-        msg = f'Initialising State "{cls.get_name()}"...'
-        logger.info(msg)
-        self = cls()
-        return self
+        raise NotImplementedError
 
     @classmethod
     def launch(cls):
         """
 
-        Launch StreamLit, if not already running - otherwise get self from cache and render
+        Initialise self and launch.
 
         """
+        self = cls()
+        logger.info(f"Launching {self.TITLE} at http://{self.HOST}:{self.PORT}")
+        ft.app(self.render, view=self.APPVIEW, host=self.HOST, port=self.PORT, assets_dir=self.PATH_ASSETS)
 
-        st = get_streamlit()
-
-        if cls.is_streamlit():
-
-            if cls.IS_ASYNC:
-                from fmtr.tools import async_tools
-                async_tools.ensure_loop()
-
-            self = st.cache_resource(show_spinner=False)(cls.get_state)()
-            logger.debug(f'Rendering Interface "{self.get_name()}" with state: {st.session_state}...')
-            self.set_title()
-            self.render()
-        else:
-            logger.info(f'Launching Streamlit interface "{cls.get_name()}"...')
-            from streamlit.web import bootstrap
-            bootstrap.run(cls.PATH, False, [], {})
-
-
-class InterfaceTest(Interface):
-    NAME: ClassVar = 'Test Interface'
-
-    parent: Base = None
-
-    def render(self):
-        """
-
-        Render the Interface
-
-        """
-        if not self.st.button('Run Test'):
-            return
-        msg = 'Running test...'
-        with self.st.spinner(msg):
-            sleep(3)
-        self.st.success("Success!")
-
-
-if __name__ == '__main__':
-    InterfaceTest.launch()
 
+if __name__ == "__main__":
+    Interface.launch()

fmtr/tools/path_tools.py

@@ -96,6 +96,29 @@ class Path(type(Path())):
         """
         return cls(gettempdir())
 
+    @classmethod
+    def data(cls, name='data') -> 'Path':
+        """
+
+        Fetch canonical "data"/"artifacts" path, whether calling package is regular or namespace package.
+
+        """
+        from fmtr.tools.inspection_tools import get_call_path
+        path = get_call_path()
+        path = path.absolute().parent.parent
+
+        path /= name
+
+        if path.exists():
+            return path
+
+        path = path.parent.parent / name
+
+        if path.exists():
+            return path
+
+        raise FileNotFoundError(f'No "{name}" directory found at "{path}"')
+
     def write_json(self, obj) -> int:
         """
 

fmtr/tools/string_tools.py

@@ -145,3 +145,10 @@ class Mask:
             return text
         except (KeyError, IndexError):
             return self
+
+
+if __name__ == '__main__':
+    import numpy as np
+
+    st = join([1, None, 'test', np.nan, 0, '', 'yeah'])
+    st

fmtr/tools/version

@@ -1 +1 @@
-1.0.30
+1.0.32

{fmtr.tools-1.0.30.dist-info → fmtr.tools-1.0.32.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fmtr.tools
-Version: 1.0.30
+Version: 1.0.32
 Summary: Collection of high-level tools to simplify everyday development tasks, with a focus on AI/ML
 Home-page: https://github.com/fmtr/fmtr.tools
 Author: Frontmatter
@@ -46,8 +46,10 @@ Requires-Dist: huggingface-hub ; extra == 'hfh'
 Provides-Extra: html
 Requires-Dist: html2text ; extra == 'html'
 Provides-Extra: interface
+Requires-Dist: flet-video ; extra == 'interface'
+Requires-Dist: flet-webview ; extra == 'interface'
+Requires-Dist: flet[all] ; extra == 'interface'
 Requires-Dist: pydantic ; extra == 'interface'
-Requires-Dist: streamlit ; extra == 'interface'
 Provides-Extra: json-fix
 Requires-Dist: json-repair ; extra == 'json-fix'
 Provides-Extra: logging
@@ -86,6 +88,9 @@ Requires-Dist: distributed ; extra == 'test'
 Requires-Dist: docker ; extra == 'test'
 Requires-Dist: faker ; extra == 'test'
 Requires-Dist: fastapi ; extra == 'test'
+Requires-Dist: flet-video ; extra == 'test'
+Requires-Dist: flet-webview ; extra == 'test'
+Requires-Dist: flet[all] ; extra == 'test'
 Requires-Dist: google-api-python-client ; extra == 'test'
 Requires-Dist: google-auth ; extra == 'test'
 Requires-Dist: google-auth-httplib2 ; extra == 'test'
@@ -105,7 +110,6 @@ Requires-Dist: pyyaml ; extra == 'test'
 Requires-Dist: semver ; extra == 'test'
 Requires-Dist: sentence-transformers ; extra == 'test'
 Requires-Dist: sre-yield ; extra == 'test'
-Requires-Dist: streamlit ; extra == 'test'
 Requires-Dist: tinynetrc ; extra == 'test'
 Requires-Dist: tokenizers ; extra == 'test'
 Requires-Dist: torchaudio ; extra == 'test'
@@ -225,7 +229,7 @@ The included modules, plus any extra requirements, are as follows:
   - Extras: `hfh`
 - `tools.html`: Utilities for converting HTML documents to plain text.
   - Extras: `html`
-- `tools.interface`: Provides a base class for building Streamlit interfaces with a class-based structure.
+- `tools.interface`: Provides a base class for building Flutter/Flet apps.
   - Extras: `interface`
 - `tools.iterator`: Pivoting/unpivoting data structures
     - Extras: None

{fmtr.tools-1.0.30.dist-info → fmtr.tools-1.0.32.dist-info}/RECORD

@@ -1,6 +1,6 @@
 fmtr/tools/__init__.py,sha256=imKjjZg5HypnRy5bD4Xe6HBkQhavg6BOkwIeFzItG_8,5052
 fmtr/tools/ai_tools.py,sha256=hN7DzuATXfurCDHugaluUsbmF_PzeKu3BTc2WXhG59g,11806
-fmtr/tools/api_tools.py,sha256=KU_qetI7WQRZijZ0l1nCKjPcRbseMMCWj0W8n_NTJCM,2027
+fmtr/tools/api_tools.py,sha256=u5YEdKyKto8MKY8legULLU7xeJ7lY2Bgyaep_xa8iZg,2089
 fmtr/tools/async_tools.py,sha256=ewz757WcveQJd-G5SVr2JDOQVbdLGecCgl-tsBGVZz4,284
 fmtr/tools/augmentation_tools.py,sha256=-6ESbO4CDlKqVOV1J1V6qBeoBMzbFIinkDHRHnCBej0,55
 fmtr/tools/caching_tools.py,sha256=UOCYUNvLQ-NofR_dhqBmZF96-HRPf4At5MmxVk3gAIk,2943
@@ -19,7 +19,7 @@ fmtr/tools/hfh_tools.py,sha256=DCDIWuWlhtmIGCtp9cLcOTTEw_4yN_NocLX8w5NZsbk,2384
 fmtr/tools/html_tools.py,sha256=0nN8Nz5HtG9bXyApYfHSKEivLlxjsm3Gn6Mg2TK0brI,394
 fmtr/tools/import_tools.py,sha256=XJmiWLukRncJAcaGReDn4jIz1_IpVBjfYCQHH1hIg7c,588
 fmtr/tools/inspection_tools.py,sha256=tLTRvzy9XVomQPi0dfnF_cgwc7KiDVZAr7gPTk4S_bQ,278
-fmtr/tools/interface_tools.py,sha256=fi0KW0veB2NQCmVmCA9iJUL_03gz0MD-gJ4OK-QUBVA,4481
+fmtr/tools/interface_tools.py,sha256=JVYUV7wuMr24BORuUtNaBlTeBFt8VDGJ3HPRajd7Y_4,1341
 fmtr/tools/iterator_tools.py,sha256=xj5f0c7LgLK53dddRRRJxBoLaBzlZoQS3_GfmpDPMoo,1311
 fmtr/tools/json_fix_tools.py,sha256=vNSlswVQnujPmKEqDjFJcO901mjMyv59q3awsT7mlhs,477
 fmtr/tools/json_tools.py,sha256=IKmrANhcftIz2msCZeItidJ1PcpY_tnbfxbRDnta-c0,349
@@ -30,18 +30,18 @@ fmtr/tools/name_tools.py,sha256=5CB_phqhHjl66iI8oLxOGPF2odC1apdul-M8Fv2xBhs,5514
 fmtr/tools/netrc_tools.py,sha256=PpNpz_mWlQi6VHGromKwFfTyLpHUXsd4LY6-OKLCbeI,376
 fmtr/tools/openai_tools.py,sha256=6SUgejgzUzmlKKct2_ePXntvMegu3FJgfk9x7aqtqYc,742
 fmtr/tools/parallel_tools.py,sha256=G__ZbLRRx4cP5OyqY1hKwnE-VI3m5prYABB0tnZHnes,3132
-fmtr/tools/path_tools.py,sha256=iNIG-nxBX-uiyfyOapJZaUiS4pI8sHsxm6WhVHixQ0M,3700
+fmtr/tools/path_tools.py,sha256=1GeWXdhV5rH99IfLI5ZFEnOJfs4Q4mYTT2R-rA791iQ,4273
 fmtr/tools/platform_tools.py,sha256=7p69CmAHe_sF68Fx9uVhns1k5EewTHTWgUYzkl6ZQKA,308
 fmtr/tools/process_tools.py,sha256=Ysh5Dk2QFBhXQerArjKdt7xZd3JrN5Ho02AaOjH0Nnw,1425
 fmtr/tools/profiling_tools.py,sha256=jpXVjaNKPydTasEQVNXvxzGtMhXPit08AnJddkU8uIc,46
 fmtr/tools/random_tools.py,sha256=4VlQdk5THbR8ka4pZaLbk_ZO_4yy6PF_lHZes_rgenY,2223
 fmtr/tools/semantic_tools.py,sha256=cxY9NSAHWj4nEc6Oj4qA1omR3dWbl2OuH7_PkINc6_E,1386
 fmtr/tools/spaces_tools.py,sha256=D_he3mve6DruB3OPS6QyzqD05ChHnRTb4buViKPe7To,1099
-fmtr/tools/string_tools.py,sha256=w0lw70bgzJ8tAHj_4lMrjtMyefE5kELgpCBgGzGcalo,3117
+fmtr/tools/string_tools.py,sha256=U2EptMWR6KDOP22ZQ4ReUHV4i25SP7xwCmZScI1sy4M,3233
 fmtr/tools/tokenization_tools.py,sha256=9FP5vgPufWv0XA961eVKObFll0d_2mM0W3ut3rtZyeo,4329
 fmtr/tools/tools.py,sha256=xnfUrOnrT4OxFYez6vV5tAhydzCICJFiGVnviiZDEQo,796
 fmtr/tools/unicode_tools.py,sha256=yS_9wpu8ogNoiIL7s1G_8bETFFO_YQlo4LNPv1NLDeY,52
-fmtr/tools/version,sha256=KqCSJDZneRpdDeee96Q2BTV-S_j2zzKb31hTn-S4o9E,6
+fmtr/tools/version,sha256=lJlaFE-y4dFjsYr6jbTGb5uzUQ_dp_LO5e9G4R2TeMk,6
 fmtr/tools/version_tools.py,sha256=axzzHBS9V1n6YuSacsDKG3VfAvRqR8qr6aENCibR8vs,1248
 fmtr/tools/yaml_tools.py,sha256=Ol43ZwbnSXGnn1K98Uxx61KPGSqfC4axE-X2q1LKMwk,349
 fmtr/tools/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -52,9 +52,9 @@ fmtr/tools/tests/test_environment.py,sha256=iHaiMQfECYZPkPKwfuIZV9uHuWe3aE-p_dN_
 fmtr/tools/tests/test_json.py,sha256=IeSP4ziPvRcmS8kq7k9tHonC9rN5YYq9GSNT2ul6Msk,287
 fmtr/tools/tests/test_path.py,sha256=AkZQa6_8BQ-VaCyL_J-iKmdf2ZaM-xFYR37Kun3k4_g,2188
 fmtr/tools/tests/test_yaml.py,sha256=jc0TwwKu9eC0LvFGNMERdgBue591xwLxYXFbtsRwXVM,287
-fmtr.tools-1.0.30.dist-info/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
-fmtr.tools-1.0.30.dist-info/METADATA,sha256=DI1kVQoW1YTrWGUSknWyCbVtPvThmbgJDwrEJ-_oTP4,13049
-fmtr.tools-1.0.30.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-fmtr.tools-1.0.30.dist-info/entry_points.txt,sha256=CEStVkwJ1mTFvhN1WV5RdW83SkNW1d5Syj-KZ6A19ng,72
-fmtr.tools-1.0.30.dist-info/top_level.txt,sha256=t5341a8ii3n4RFizwTeXGmcq_pf4GqL1h9ylE5LIWRk,12
-fmtr.tools-1.0.30.dist-info/RECORD,,
+fmtr.tools-1.0.32.dist-info/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
+fmtr.tools-1.0.32.dist-info/METADATA,sha256=iPCoZOCJ1UbUM0x2NVVcWQiEg-Co8RZNSQIy1cgHErQ,13207
+fmtr.tools-1.0.32.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+fmtr.tools-1.0.32.dist-info/entry_points.txt,sha256=CEStVkwJ1mTFvhN1WV5RdW83SkNW1d5Syj-KZ6A19ng,72
+fmtr.tools-1.0.32.dist-info/top_level.txt,sha256=t5341a8ii3n4RFizwTeXGmcq_pf4GqL1h9ylE5LIWRk,12
+fmtr.tools-1.0.32.dist-info/RECORD,,