fmtr.tools 1.1.9__py3-none-any.whl → 1.1.11__py3-none-any.whl

fmtr/tools/__init__.py

@@ -19,10 +19,11 @@ import fmtr.tools.string_tools as string
 import fmtr.tools.name_tools as name
 import fmtr.tools.logging_tools as logging
 import fmtr.tools.async_tools as asyncio
+import fmtr.tools.packaging_tools as packaging
 from fmtr.tools.logging_tools import logger
 
 from fmtr.tools.import_tools import MissingExtraMockModule
-from fmtr.tools.path_tools import Path, PackagePaths
+from fmtr.tools.path_tools import Path, PackagePaths, AppPaths
 from fmtr.tools.constants import Constants
 
 try:

fmtr/tools/packaging_tools.py

@@ -0,0 +1,14 @@
+import importlib.metadata
+
+
+def get_version(module):
+    """
+
+    Retrieve the version of a specified module.
+
+    """
+
+    if type(module) is not str:
+        module = module.__name__
+    version = importlib.metadata.version(module)
+    return version

fmtr/tools/path_tools/__init__.py

@@ -0,0 +1,7 @@
+from fmtr.tools.import_tools import MissingExtraMockModule
+from fmtr.tools.path_tools.base import Path, PackagePaths
+
+try:
+    from fmtr.tools.path_tools.app import AppPaths
+except ImportError as exception:
+    AppPaths = MissingExtraMockModule('path.app', exception)

fmtr/tools/path_tools/app.py

@@ -0,0 +1,40 @@
+import appdirs
+
+from fmtr.tools.path_tools import Path
+
+
+class AppPaths:
+    """
+
+    Wrap appdirs to return Path objects
+
+    """
+    PathType = Path
+
+    def user_data_dir(self, appname=None, appauthor=None, version=None, roaming=False):
+        path_str = appdirs.user_data_dir(appname=appname, appauthor=appauthor, version=version, roaming=roaming)
+        return self.PathType(path_str)
+
+    def user_config_dir(self, appname=None, appauthor=None, version=None, roaming=False):
+        path_str = appdirs.user_config_dir(appname=appname, appauthor=appauthor, version=version, roaming=roaming)
+        return self.PathType(path_str)
+
+    def site_config_dir(self, appname=None, appauthor=None, version=None):
+        path_str = appdirs.site_config_dir(appname=appname, appauthor=appauthor, version=version, multipath=False)
+        return self.PathType(path_str)
+
+    def site_data_dir(self, appname=None, appauthor=None, version=None):
+        path_str = appdirs.site_data_dir(appname=appname, appauthor=appauthor, version=version, multipath=False)
+        return self.PathType(path_str)
+
+    def user_cache_dir(self, appname=None, appauthor=None, version=None):
+        path_str = appdirs.user_cache_dir(appname=appname, appauthor=appauthor, version=version)
+        return self.PathType(path_str)
+
+    def user_state_dir(self, appname=None, appauthor=None, version=None):
+        path_str = appdirs.user_state_dir(appname=appname, appauthor=appauthor, version=version)
+        return self.PathType(path_str)
+
+    def user_log_dir(self, appname=None, appauthor=None, version=None):
+        path_str = appdirs.user_log_dir(appname=appname, appauthor=appauthor, version=version)
+        return self.PathType(path_str)

fmtr/tools/{path_tools.py → path_tools/base.py}

@@ -154,6 +154,15 @@ class Path(type(Path())):
         """
         return super().exists()
 
+    @classmethod
+    def app(cls):
+        """
+
+        Convenience method for getting application paths
+
+        """
+        from fmtr.tools import path
+        return path.AppPaths()
 
 class PackagePaths:
     """
@@ -315,5 +324,6 @@ class PackagePaths:
 
 
 if __name__ == "__main__":
-    paths = PackagePaths()
-    paths
+    path = Path()
+    path.app.user_log_dir()
+    path

fmtr/tools/version

@@ -1 +1 @@
-1.1.9
+1.1.11

fmtr/tools/yaml_tools.py

@@ -1,12 +1,58 @@
+from functools import lru_cache
 from typing import Any
-from yaml import CLoader as Loader, CDumper as Dumper
-from yaml import load, dump
+from yaml import CDumper as Dumper
+from yaml import dump
 
+from fmtr.tools import environment_tools as env
+
+
+def install():
+    """
+
+    Installs the YAML Script runtime binary of the specified version.
 
-def to_yaml(obj: Any) -> str:
     """
+    import subprocess
+    from fmtr.tools import logger, packaging
+
+    version = packaging.get_version('yamlscript')
+    logger.warning(f"Installing YAML Script runtime binary version {version}...")
+    result = subprocess.run(f"curl https://yamlscript.org/install | VERSION={version} LIB=1 bash", shell=True, check=True)
+    return result
 
 
+@lru_cache
+def get_module(is_auto=env.IS_DEBUG):
+    """
+
+    Get the YAML Script runtime module, installing the runtime if specified
+
+    """
+    try:
+        import yamlscript
+    except Exception as exception:
+        if not is_auto:
+            raise ImportError(f'YAML Script runtime missing and {is_auto=}. Set to {True} to install.') from exception
+        install()
+        import yamlscript
+    return yamlscript
+
+
+@lru_cache
+def get_interpreter():
+    """
+
+    Fetches and returns a cached instance of the YAMLScript interpreter.
+
+    """
+    module = get_module()
+    interpreter = module.YAMLScript()
+    return interpreter
+
+def to_yaml(obj: Any) -> str:
+    """
+
+    Serialize to YAML
 
     """
     yaml_str = dump(obj, allow_unicode=True, Dumper=Dumper)
@@ -16,8 +62,8 @@ def to_yaml(obj: Any) -> str:
 def from_yaml(yaml_str: str) -> Any:
     """
 
-
+    Deserialize from YAML
 
     """
-    obj = load(yaml_str, Loader=Loader)
+    obj = get_interpreter().load(yaml_str)
     return obj

{fmtr_tools-1.1.9.dist-info → fmtr_tools-1.1.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmtr.tools
-Version: 1.1.9
+Version: 1.1.11
 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
@@ -9,53 +9,54 @@ License: Copyright © 2025 Frontmatter. All rights reserved.
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Provides-Extra: test
-Requires-Dist: json_repair; extra == "test"
-Requires-Dist: pydantic-ai[logfire,openai]; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: openai; extra == "test"
-Requires-Dist: tabulate; extra == "test"
-Requires-Dist: google-auth-httplib2; extra == "test"
-Requires-Dist: openpyxl; extra == "test"
+Requires-Dist: flet-webview; extra == "test"
 Requires-Dist: fastapi; extra == "test"
+Requires-Dist: pymupdf4llm; extra == "test"
 Requires-Dist: Unidecode; extra == "test"
-Requires-Dist: flet[all]; extra == "test"
-Requires-Dist: dask[bag]; extra == "test"
-Requires-Dist: uvicorn[standard]; extra == "test"
-Requires-Dist: pydevd-pycharm; extra == "test"
-Requires-Dist: huggingface_hub; extra == "test"
-Requires-Dist: logfire; extra == "test"
-Requires-Dist: pyyaml; extra == "test"
-Requires-Dist: sre_yield; extra == "test"
-Requires-Dist: docker; extra == "test"
-Requires-Dist: flet-webview; extra == "test"
-Requires-Dist: logfire[fastapi]; extra == "test"
-Requires-Dist: bokeh; extra == "test"
-Requires-Dist: pydantic; extra == "test"
-Requires-Dist: pandas; extra == "test"
 Requires-Dist: semver; extra == "test"
-Requires-Dist: faker; extra == "test"
-Requires-Dist: contexttimer; extra == "test"
-Requires-Dist: pymupdf4llm; extra == "test"
 Requires-Dist: pydantic-settings; extra == "test"
-Requires-Dist: peft; extra == "test"
-Requires-Dist: torchaudio; extra == "test"
-Requires-Dist: google-auth; extra == "test"
-Requires-Dist: flet-video; extra == "test"
-Requires-Dist: tinynetrc; extra == "test"
-Requires-Dist: torchvision; extra == "test"
+Requires-Dist: google-auth-httplib2; extra == "test"
+Requires-Dist: pandas; extra == "test"
 Requires-Dist: google-auth-oauthlib; extra == "test"
-Requires-Dist: deepmerge; extra == "test"
-Requires-Dist: distributed; extra == "test"
+Requires-Dist: openai; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: transformers[sentencepiece]; extra == "test"
-Requires-Dist: ollama; extra == "test"
+Requires-Dist: logfire; extra == "test"
+Requires-Dist: pydantic; extra == "test"
+Requires-Dist: deepmerge; extra == "test"
 Requires-Dist: pymupdf; extra == "test"
-Requires-Dist: html2text; extra == "test"
 Requires-Dist: sentence_transformers; extra == "test"
-Requires-Dist: tokenizers; extra == "test"
+Requires-Dist: html2text; extra == "test"
+Requires-Dist: sre_yield; extra == "test"
+Requires-Dist: flet[all]; extra == "test"
+Requires-Dist: peft; extra == "test"
+Requires-Dist: pydantic-ai[logfire,openai]; extra == "test"
+Requires-Dist: appdirs; extra == "test"
 Requires-Dist: google-api-python-client; extra == "test"
+Requires-Dist: json_repair; extra == "test"
+Requires-Dist: dask[bag]; extra == "test"
+Requires-Dist: torchaudio; extra == "test"
+Requires-Dist: google-auth; extra == "test"
+Requires-Dist: tabulate; extra == "test"
+Requires-Dist: tokenizers; extra == "test"
+Requires-Dist: ollama; extra == "test"
+Requires-Dist: torchvision; extra == "test"
+Requires-Dist: yamlscript; extra == "test"
+Requires-Dist: faker; extra == "test"
+Requires-Dist: bokeh; extra == "test"
+Requires-Dist: docker; extra == "test"
+Requires-Dist: tinynetrc; extra == "test"
+Requires-Dist: uvicorn[standard]; extra == "test"
+Requires-Dist: openpyxl; extra == "test"
 Requires-Dist: diskcache; extra == "test"
+Requires-Dist: pydevd-pycharm; extra == "test"
+Requires-Dist: logfire[fastapi]; extra == "test"
+Requires-Dist: contexttimer; extra == "test"
+Requires-Dist: distributed; extra == "test"
+Requires-Dist: flet-video; extra == "test"
+Requires-Dist: huggingface_hub; extra == "test"
 Provides-Extra: yaml
-Requires-Dist: pyyaml; extra == "yaml"
+Requires-Dist: yamlscript; extra == "yaml"
 Provides-Extra: logging
 Requires-Dist: logfire; extra == "logging"
 Requires-Dist: semver; extra == "logging"
@@ -149,6 +150,8 @@ Requires-Dist: pydevd-pycharm; extra == "debug"
 Provides-Extra: sets
 Requires-Dist: pydantic-settings; extra == "sets"
 Requires-Dist: pydantic; extra == "sets"
+Provides-Extra: path-app
+Requires-Dist: appdirs; extra == "path-app"
 Dynamic: author
 Dynamic: author-email
 Dynamic: description
@@ -283,9 +286,10 @@ The included modules, plus any extra requirements, are as follows:
 - `tools.Path`: Enhanced
   `pathlib.Path` object with additional functionality for Windows-to-Unix path conversion in WSL environments, reading/writing JSON and YAML files with proper encoding.
     - Extras: None
--
 `tools.PackagePaths` class for managing canonical package paths, like settings files, artifact directories, version files.
   - Extras: None
+    `tools.AppPaths` Wrapper around `appdirs` for application paths.
+  - Extras: `paths.app`
 - `tools.platform`: Detecting if host is WSL, Docker etc.
     - Extras: None
 - `tools.ContextProcess`: Manages a function running in a separate process using a context manager. Provides methods to start, stop, and restart the process, with configurable restart delays. Useful for ensuring clean process management and automatic stopping when the context manager exits.

{fmtr_tools-1.1.9.dist-info → fmtr_tools-1.1.11.dist-info}/RECORD

@@ -1,4 +1,4 @@
-fmtr/tools/__init__.py,sha256=_p8-qJSEfrdI5Kc1tTQ7RzIk7dbAcJ9yf0lpLEN4n80,5196
+fmtr/tools/__init__.py,sha256=LbCse2Z1oZh3ENnb3_A5xwtC58IGNEJIn0faBNdgOGA,5253
 fmtr/tools/api_tools.py,sha256=w8Zrp_EwN5KlUghwLoTCXo4z1irg5tAsReCqDLjASfE,2133
 fmtr/tools/async_tools.py,sha256=ewz757WcveQJd-G5SVr2JDOQVbdLGecCgl-tsBGVZz4,284
 fmtr/tools/augmentation_tools.py,sha256=-6ESbO4CDlKqVOV1J1V6qBeoBMzbFIinkDHRHnCBej0,55
@@ -28,8 +28,8 @@ fmtr/tools/metric_tools.py,sha256=Lvia5CGFRIfrDFA8s37btIfTU5zHbo04cPJdAMtbndQ,27
 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/packaging_tools.py,sha256=FlgOTnDRHZWQL2iR-wucTsyGEHRE-MlddKL30MPmUqE,253
 fmtr/tools/parallel_tools.py,sha256=QEb_gN1StkxsqYaH4HSjiJX8Y3gpb2uKNsOzG4uFpaM,3071
-fmtr/tools/path_tools.py,sha256=f4FOFhWdC5U1yeMtHPQatvXhs6cCTCC4RuPoLZo0kRE,7094
 fmtr/tools/pdf_tools.py,sha256=xvv9B84uAF81rFJRnXhSsxYuP42vY9ZdPVFrSMVe8G8,4069
 fmtr/tools/platform_tools.py,sha256=7p69CmAHe_sF68Fx9uVhns1k5EewTHTWgUYzkl6ZQKA,308
 fmtr/tools/process_tools.py,sha256=Ysh5Dk2QFBhXQerArjKdt7xZd3JrN5Ho02AaOjH0Nnw,1425
@@ -43,12 +43,15 @@ fmtr/tools/tabular_tools.py,sha256=tpIpZzYku1HcJrHZJL6BC39LmN3WUWVhFbK2N7nDVmE,1
 fmtr/tools/tokenization_tools.py,sha256=me-IBzSLyNYejLybwjO9CNB6Mj2NYfKPaOVThXyaGNg,4268
 fmtr/tools/tools.py,sha256=CAsApa1YwVdNE6H66Vjivs_mXYvOas3rh7fPELAnTpk,795
 fmtr/tools/unicode_tools.py,sha256=yS_9wpu8ogNoiIL7s1G_8bETFFO_YQlo4LNPv1NLDeY,52
-fmtr/tools/version,sha256=SEVut3Hfqhsf1g__PFKzWToL-USJphz5a0yDCdBCZyY,5
+fmtr/tools/version,sha256=ru3slBiEnrsfqniKVioHigGLwx3RDu7XA86xIx6JHzg,6
 fmtr/tools/version_tools.py,sha256=yNs_CGqWpqE4jbK9wsPIi14peJVXYbhIcMqHAFOw3yE,1480
-fmtr/tools/yaml_tools.py,sha256=Ol43ZwbnSXGnn1K98Uxx61KPGSqfC4axE-X2q1LKMwk,349
+fmtr/tools/yaml_tools.py,sha256=RVm-PuTv5XNneMea9iZ-x-oI3UdpbLi2-KA0rSf2ybk,1537
 fmtr/tools/ai_tools/__init__.py,sha256=JZrLuOFNV1A3wvJgonxOgz_4WS-7MfCuowGWA5uYCjs,372
 fmtr/tools/ai_tools/agentic_tools.py,sha256=YebH7R9ovVo3GzfWAZxY49e2fNt13APDMe290xx7zks,3720
 fmtr/tools/ai_tools/inference_tools.py,sha256=yF8Oxph0L8W2CnK_o-MVztBhWVwBpgOEkx9_m3uqQww,11840
+fmtr/tools/path_tools/__init__.py,sha256=HENHHpkyBwSm2VTWV0Fz8FP3WjgjjhnR0TYPNbSSpyQ,268
+fmtr/tools/path_tools/app.py,sha256=JrJvtTDd_gkCKcZtBCDTMktsM77PZwGV_hzQX0g5GU8,1722
+fmtr/tools/path_tools/base.py,sha256=DOWXky4DOLqkrbw7fGP8StaAFiqSJqe_oYW_qCKuPrU,7297
 fmtr/tools/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fmtr/tools/tests/conftest.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fmtr/tools/tests/helpers.py,sha256=N5sf9YoZV93a7tf_UxpLeyQ9vp6Ec0teNIimFDvc054,1091
@@ -57,9 +60,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.1.9.dist-info/licenses/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
-fmtr_tools-1.1.9.dist-info/METADATA,sha256=Xzod21_rMKKLHj7K5Zi37jKRsCSFRmDaOe6f_ui5-i4,14646
-fmtr_tools-1.1.9.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-fmtr_tools-1.1.9.dist-info/entry_points.txt,sha256=e-eOW1Ml13tbxHC6Er1MnVOEDePeWw7DKwlE-l-gCY0,205
-fmtr_tools-1.1.9.dist-info/top_level.txt,sha256=t5341a8ii3n4RFizwTeXGmcq_pf4GqL1h9ylE5LIWRk,12
-fmtr_tools-1.1.9.dist-info/RECORD,,
+fmtr_tools-1.1.11.dist-info/licenses/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
+fmtr_tools-1.1.11.dist-info/METADATA,sha256=-HlRFfrUTtI4k10csfs6idMFnFYMkF8ikUM_nD3BQJk,14855
+fmtr_tools-1.1.11.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+fmtr_tools-1.1.11.dist-info/entry_points.txt,sha256=e-eOW1Ml13tbxHC6Er1MnVOEDePeWw7DKwlE-l-gCY0,205
+fmtr_tools-1.1.11.dist-info/top_level.txt,sha256=LXem9xCgNOD72tE2gRKESdiQTL902mfFkwWb6-dlwEE,5
+fmtr_tools-1.1.11.dist-info/RECORD,,

fmtr_tools-1.1.11.dist-info/top_level.txt

@@ -0,0 +1 @@
+fmtr

fmtr_tools-1.1.9.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-docker
-fmtr