fmtr.tools 1.1.9__tar.gz → 1.1.11__tar.gz

{fmtr_tools-1.1.9 → fmtr_tools-1.1.11}/PKG-INFO

@@ -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 → fmtr_tools-1.1.11}/README.md

@@ -122,9 +122,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 → fmtr_tools-1.1.11}/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-1.1.11/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-1.1.11/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-1.1.11/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-1.1.9/fmtr/tools/path_tools.py → fmtr_tools-1.1.11/fmtr/tools/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-1.1.11/fmtr/tools/version

@@ -0,0 +1 @@
+1.1.11

fmtr_tools-1.1.11/fmtr/tools/yaml_tools.py

@@ -0,0 +1,69 @@
+from functools import lru_cache
+from typing import Any
+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.
+
+    """
+    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)
+    return yaml_str
+
+
+def from_yaml(yaml_str: str) -> Any:
+    """
+
+    Deserialize from YAML
+
+    """
+    obj = get_interpreter().load(yaml_str)
+    return obj

{fmtr_tools-1.1.9 → fmtr_tools-1.1.11}/fmtr.tools.egg-info/PKG-INFO

@@ -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 → fmtr_tools-1.1.11}/fmtr.tools.egg-info/SOURCES.txt

@@ -31,8 +31,8 @@ setup.py
 ./fmtr/tools/name_tools.py
 ./fmtr/tools/netrc_tools.py
 ./fmtr/tools/openai_tools.py
+./fmtr/tools/packaging_tools.py
 ./fmtr/tools/parallel_tools.py
-./fmtr/tools/path_tools.py
 ./fmtr/tools/pdf_tools.py
 ./fmtr/tools/platform_tools.py
 ./fmtr/tools/process_tools.py
@@ -52,6 +52,9 @@ setup.py
 ./fmtr/tools/ai_tools/__init__.py
 ./fmtr/tools/ai_tools/agentic_tools.py
 ./fmtr/tools/ai_tools/inference_tools.py
+./fmtr/tools/path_tools/__init__.py
+./fmtr/tools/path_tools/app.py
+./fmtr/tools/path_tools/base.py
 ./fmtr/tools/tests/__init__.py
 ./fmtr/tools/tests/conftest.py
 ./fmtr/tools/tests/helpers.py

{fmtr_tools-1.1.9 → fmtr_tools-1.1.11}/fmtr.tools.egg-info/requires.txt

@@ -82,6 +82,9 @@ dask[bag]
 distributed
 bokeh
 
+[path.app]
+appdirs
+
 [pdf]
 pymupdf
 pydantic
@@ -113,51 +116,52 @@ tabulate
 openpyxl
 
 [test]
-json_repair
-pydantic-ai[logfire,openai]
-pytest-cov
-openai
-tabulate
-google-auth-httplib2
-openpyxl
+flet-webview
 fastapi
+pymupdf4llm
 Unidecode
-flet[all]
-dask[bag]
-uvicorn[standard]
-pydevd-pycharm
-huggingface_hub
-logfire
-pyyaml
-sre_yield
-docker
-flet-webview
-logfire[fastapi]
-bokeh
-pydantic
-pandas
 semver
-faker
-contexttimer
-pymupdf4llm
 pydantic-settings
-peft
-torchaudio
-google-auth
-flet-video
-tinynetrc
-torchvision
+google-auth-httplib2
+pandas
 google-auth-oauthlib
-deepmerge
-distributed
+openai
+pytest-cov
 transformers[sentencepiece]
-ollama
+logfire
+pydantic
+deepmerge
 pymupdf
-html2text
 sentence_transformers
-tokenizers
+html2text
+sre_yield
+flet[all]
+peft
+pydantic-ai[logfire,openai]
+appdirs
 google-api-python-client
+json_repair
+dask[bag]
+torchaudio
+google-auth
+tabulate
+tokenizers
+ollama
+torchvision
+yamlscript
+faker
+bokeh
+docker
+tinynetrc
+uvicorn[standard]
+openpyxl
 diskcache
+pydevd-pycharm
+logfire[fastapi]
+contexttimer
+distributed
+flet-video
+huggingface_hub
 
 [tokenization]
 tokenizers
@@ -169,4 +173,4 @@ Unidecode
 semver
 
 [yaml]
-pyyaml
+yamlscript

fmtr_tools-1.1.11/fmtr.tools.egg-info/top_level.txt

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

fmtr_tools-1.1.9/fmtr/tools/version

@@ -1 +0,0 @@
-1.1.9

fmtr_tools-1.1.9/fmtr/tools/yaml_tools.py

@@ -1,23 +0,0 @@
-from typing import Any
-from yaml import CLoader as Loader, CDumper as Dumper
-from yaml import load, dump
-
-
-def to_yaml(obj: Any) -> str:
-    """
-
-
-
-    """
-    yaml_str = dump(obj, allow_unicode=True, Dumper=Dumper)
-    return yaml_str
-
-
-def from_yaml(yaml_str: str) -> Any:
-    """
-
-
-
-    """
-    obj = load(yaml_str, Loader=Loader)
-    return obj

fmtr_tools-1.1.9/fmtr.tools.egg-info/top_level.txt

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