fmtr.tools 1.3.75__py3-none-any.whl → 1.3.76__py3-none-any.whl

fmtr/tools/constants.py

@@ -46,7 +46,10 @@ class Constants:
     FILENAME_VERSION = 'version'
     DIR_NAME_HF = 'hf'
 
-    ENTRYPOINTS_DIR = 'entrypoints'
+    ENTRYPOINT = 'entrypoint'
+    ENTRYPOINTS_DIR = f'{ENTRYPOINT}s'
+    ENTRYPOINT_FILE = f'{ENTRYPOINT}.py'
+
     PACKAGE_EXCLUDE_DIRS = {'data', 'build', 'dist', '.*', '*egg-info*'}
     INIT_FILENAME = '__init__.py'
 

fmtr/tools/data_modelling_tools.py

@@ -182,8 +182,38 @@ class MixinFromJson:
         return self
 
 
+class CliRunMixin:
+    """
+
+    Mixin only so that it can also be used with Pydantic Settings.
+
+    TODO Ideally, the run method would be defined on dm.Base and the settings base would just inherit like set.Base(BaseSettings, dm.Base), but this isn't yet tested/could break Fields.
+
+    """
+
+    def run(self):
+        """
+
+        Behaviour when run as a CLI command, i.e. via Pydantic Settings. Run any subcommands then exit.
+
+        """
+
+        from pydantic_settings import get_subcommand
+
+        command = get_subcommand(self, is_required=False, cli_exit_on_error=False)
+
+        if not command:
+            return
+
+        result = command.run()
+        if inspect.isawaitable(result):
+            import asyncio
+            result = asyncio.run(result)
+
+        raise SystemExit(result)
+
 
-class Base(BaseModel, MixinFromJson):
+class Base(BaseModel, MixinFromJson, CliRunMixin):
     """
 
     Base model allowing model definition via a list of custom Field objects.

fmtr/tools/settings_tools.py

@@ -1,6 +1,8 @@
-from pydantic_settings import BaseSettings, PydanticBaseSettingsSource, YamlConfigSettingsSource, EnvSettingsSource, CliSettingsSource
 from typing import ClassVar, Any
 
+from pydantic_settings import BaseSettings, PydanticBaseSettingsSource, YamlConfigSettingsSource, EnvSettingsSource, CliSettingsSource
+
+from fmtr.tools.data_modelling_tools import CliRunMixin
 from fmtr.tools.path_tools import PackagePaths, Path
 
 
@@ -21,7 +23,7 @@ class YamlScriptConfigSettingsSource(YamlConfigSettingsSource):
         return data
 
 
-class Base(BaseSettings):
+class Base(BaseSettings, CliRunMixin):
     """
 
     Base class for settings configuration using Pydantic BaseSettings.

fmtr/tools/setup_tools/setup_tools.py

@@ -88,6 +88,15 @@ class SetupPaths(FromCallerMixin):
             return False
         return org
 
+    @property
+    def entrypoint(self) -> Path:
+        """
+
+        Path of base entrypoint module.
+
+        """
+        return self.path / Constants.ENTRYPOINT_FILE
+
     @property
     def entrypoints(self) -> Path:
         """
@@ -182,23 +191,38 @@ class Setup(FromCallerMixin):
     def console_scripts(self) -> List[str]:
         """
 
-        Generate console scripts for any modules in the `entrypoints` sub-package.
+        Generate console scripts for the `entrypoint` module - and/or any modules in `entrypoints` sub-package.
 
         """
 
         if not self.paths.entrypoints.exists():
-            return []
+            paths_mods = []
+        else:
+            paths_mods = list(self.paths.entrypoints.iterdir())
 
-        names_mods = [path.stem for path in self.paths.entrypoints.iterdir() if path.is_file() and path.name != Constants.INIT_FILENAME]
-        command_prefix = self.name.replace('.', self.ENTRYPOINT_COMMAND_SEP)
+        names_mods = [path.stem for path in paths_mods if path.is_file() and path.name != Constants.INIT_FILENAME]
         command_suffixes = [name_mod.replace(self.ENTRYPOINT_FUNCTION_SEP, self.ENTRYPOINT_COMMAND_SEP) for name_mod in names_mods]
-        commands = [f'{command_prefix}-{command_suffix}' for command_suffix in command_suffixes]
+        commands = [f'{self.name_command}-{command_suffix}' for command_suffix in command_suffixes]
         paths = [f'{self.name}.{Constants.ENTRYPOINTS_DIR}.{name_mod}:{self.ENTRYPOINT_FUNC_NAME}' for name_mod in names_mods]
 
+        if self.paths.entrypoint.exists():
+            commands.append(self.name_command)
+            path = f'{self.name}.{self.paths.entrypoint.stem}:{self.ENTRYPOINT_FUNC_NAME}'
+            paths.append(path)
+
         console_scripts = [f'{command} = {path}' for command, path in zip(commands, paths)]
 
         return console_scripts
 
+    @cached_property
+    def name_command(self) -> str:
+        """
+
+        Name as a command, e.g. `fmtr-tools`
+
+        """
+        return self.name.replace('.', self.ENTRYPOINT_COMMAND_SEP)
+
     @property
     def name(self) -> str:
         """

fmtr/tools/version

@@ -1 +1 @@
-1.3.75
+1.3.76

{fmtr_tools-1.3.75.dist-info → fmtr_tools-1.3.76.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmtr.tools
-Version: 1.3.75
+Version: 1.3.76
 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
@@ -21,7 +21,6 @@ Requires-Dist: pyyaml; extra == "dev"
 Requires-Dist: yamlscript; extra == "dev"
 Requires-Dist: pyyaml; extra == "dev"
 Requires-Dist: beanie[odm]; extra == "dev"
-Requires-Dist: motor; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest-cov; extra == "test"
 Provides-Extra: yaml
@@ -166,70 +165,68 @@ Requires-Dist: playwright; extra == "browsers"
 Provides-Extra: db
 Provides-Extra: db-document
 Requires-Dist: beanie[odm]; extra == "db-document"
-Requires-Dist: motor; extra == "db-document"
 Provides-Extra: all
-Requires-Dist: fastapi; extra == "all"
-Requires-Dist: flet-webview; extra == "all"
-Requires-Dist: sre_yield; extra == "all"
-Requires-Dist: html2text; extra == "all"
-Requires-Dist: cachetools; extra == "all"
-Requires-Dist: pydantic-settings; extra == "all"
 Requires-Dist: pytest-cov; extra == "all"
-Requires-Dist: diskcache; extra == "all"
-Requires-Dist: appdirs; extra == "all"
-Requires-Dist: json_repair; extra == "all"
-Requires-Dist: flet-video; extra == "all"
-Requires-Dist: dnspython[doh]; extra == "all"
-Requires-Dist: pymupdf4llm; extra == "all"
-Requires-Dist: playwright; extra == "all"
-Requires-Dist: flet[all]; extra == "all"
-Requires-Dist: faker; extra == "all"
+Requires-Dist: peft; extra == "all"
 Requires-Dist: openpyxl; extra == "all"
-Requires-Dist: logfire[httpx]; extra == "all"
-Requires-Dist: deepmerge; extra == "all"
-Requires-Dist: odfpy; extra == "all"
+Requires-Dist: pymupdf; extra == "all"
+Requires-Dist: pydevd-pycharm~=251.25410.159; extra == "all"
+Requires-Dist: tinynetrc; extra == "all"
+Requires-Dist: torchvision; extra == "all"
+Requires-Dist: google-auth-httplib2; extra == "all"
+Requires-Dist: logfire[fastapi]; extra == "all"
+Requires-Dist: uvicorn[standard]; extra == "all"
+Requires-Dist: pandas; extra == "all"
+Requires-Dist: transformers[sentencepiece]; extra == "all"
+Requires-Dist: google-auth-oauthlib; extra == "all"
+Requires-Dist: flet[all]; extra == "all"
+Requires-Dist: pyyaml; extra == "all"
+Requires-Dist: tokenizers; extra == "all"
 Requires-Dist: tabulate; extra == "all"
-Requires-Dist: pydantic-extra-types; extra == "all"
+Requires-Dist: dask[bag]; extra == "all"
+Requires-Dist: pydantic-settings; extra == "all"
+Requires-Dist: httpx; extra == "all"
+Requires-Dist: google-api-python-client; extra == "all"
+Requires-Dist: flet-webview; extra == "all"
+Requires-Dist: yamlscript; extra == "all"
 Requires-Dist: semver; extra == "all"
-Requires-Dist: logfire[fastapi]; extra == "all"
+Requires-Dist: json_repair; extra == "all"
+Requires-Dist: distributed; extra == "all"
+Requires-Dist: diskcache; extra == "all"
 Requires-Dist: contexttimer; extra == "all"
+Requires-Dist: ollama; extra == "all"
+Requires-Dist: appdirs; extra == "all"
+Requires-Dist: google-auth; extra == "all"
 Requires-Dist: pycountry; extra == "all"
-Requires-Dist: httpx_retries; extra == "all"
-Requires-Dist: yamlscript; extra == "all"
+Requires-Dist: deepmerge; extra == "all"
+Requires-Dist: pydantic-extra-types; extra == "all"
+Requires-Dist: python-on-whales; extra == "all"
 Requires-Dist: regex; extra == "all"
-Requires-Dist: uvicorn[standard]; extra == "all"
-Requires-Dist: pymupdf; extra == "all"
-Requires-Dist: filetype; extra == "all"
-Requires-Dist: motor; extra == "all"
-Requires-Dist: logfire; extra == "all"
-Requires-Dist: google-auth-httplib2; extra == "all"
-Requires-Dist: dask[bag]; extra == "all"
-Requires-Dist: setuptools; extra == "all"
-Requires-Dist: bokeh; extra == "all"
-Requires-Dist: google-auth; extra == "all"
-Requires-Dist: Unidecode; extra == "all"
+Requires-Dist: flet-video; extra == "all"
 Requires-Dist: sentence_transformers; extra == "all"
-Requires-Dist: huggingface_hub; extra == "all"
-Requires-Dist: httpx; extra == "all"
-Requires-Dist: tinynetrc; extra == "all"
-Requires-Dist: pandas; extra == "all"
-Requires-Dist: google-auth-oauthlib; extra == "all"
-Requires-Dist: torchvision; extra == "all"
-Requires-Dist: pydantic; extra == "all"
-Requires-Dist: transformers[sentencepiece]; extra == "all"
-Requires-Dist: distributed; extra == "all"
 Requires-Dist: openai; extra == "all"
 Requires-Dist: deepdiff; extra == "all"
-Requires-Dist: peft; extra == "all"
-Requires-Dist: tokenizers; extra == "all"
-Requires-Dist: pydantic-ai[logfire,openai]; extra == "all"
-Requires-Dist: python-on-whales; extra == "all"
+Requires-Dist: fastapi; extra == "all"
+Requires-Dist: bokeh; extra == "all"
+Requires-Dist: logfire; extra == "all"
 Requires-Dist: beanie[odm]; extra == "all"
-Requires-Dist: ollama; extra == "all"
+Requires-Dist: pymupdf4llm; extra == "all"
+Requires-Dist: dnspython[doh]; extra == "all"
+Requires-Dist: setuptools; extra == "all"
+Requires-Dist: playwright; extra == "all"
+Requires-Dist: filetype; extra == "all"
+Requires-Dist: pydantic; extra == "all"
+Requires-Dist: sre_yield; extra == "all"
+Requires-Dist: huggingface_hub; extra == "all"
+Requires-Dist: Unidecode; extra == "all"
+Requires-Dist: faker; extra == "all"
+Requires-Dist: pydantic-ai[logfire,openai]; extra == "all"
+Requires-Dist: odfpy; extra == "all"
+Requires-Dist: logfire[httpx]; extra == "all"
+Requires-Dist: html2text; extra == "all"
+Requires-Dist: httpx_retries; extra == "all"
 Requires-Dist: torchaudio; extra == "all"
-Requires-Dist: google-api-python-client; extra == "all"
-Requires-Dist: pydevd-pycharm~=251.25410.159; extra == "all"
-Requires-Dist: pyyaml; extra == "all"
+Requires-Dist: cachetools; extra == "all"
 Dynamic: author
 Dynamic: author-email
 Dynamic: description

{fmtr_tools-1.3.75.dist-info → fmtr_tools-1.3.76.dist-info}/RECORD

@@ -3,9 +3,9 @@ fmtr/tools/api_tools.py,sha256=RyZUlTefSQozfl-8feZGauyUkwcFd-jU0KtKHFxHea4,2272
 fmtr/tools/async_tools.py,sha256=ewz757WcveQJd-G5SVr2JDOQVbdLGecCgl-tsBGVZz4,284
 fmtr/tools/augmentation_tools.py,sha256=-6ESbO4CDlKqVOV1J1V6qBeoBMzbFIinkDHRHnCBej0,55
 fmtr/tools/caching_tools.py,sha256=74p7m2GLFfeP41LX69wxgfkilxEAoWkMIfFMjKsYpyg,4976
-fmtr/tools/constants.py,sha256=90wCirUpw4bWMAbjhip0LL6k57eS5VmxRUP9pLCChBg,1812
+fmtr/tools/constants.py,sha256=h85mq2JuOsHj-TUKnV0rYTddWFRSRAd4yLyCkpeGjX0,1887
 fmtr/tools/context_tools.py,sha256=4UvIHYgLqAh7dXMX9EBrLEpYp81qfzhSVrkffOSAoGA,350
-fmtr/tools/data_modelling_tools.py,sha256=KZlY0BkGY1DWro0lhWE1ezgbnv9wPWaj9E2CEqMnTXM,6605
+fmtr/tools/data_modelling_tools.py,sha256=c703EhL2ZIj5iN0wjuohakvUnElRblQhvFSLyfRTWwA,7416
 fmtr/tools/dataclass_tools.py,sha256=0Gt6KeLhtPgubo_2tYkIVqB8oQ91Qzag8OAGZDdjvMU,1209
 fmtr/tools/datatype_tools.py,sha256=qFPFrZK70-an4w7H46g8eT5j6Jez--U2XnmFdrQibeE,1983
 fmtr/tools/datetime_tools.py,sha256=L7wmBoQbD9h_pJIL92WQOX32r_vrXgRvE-_0PVPRAGY,232
@@ -38,14 +38,14 @@ fmtr/tools/process_tools.py,sha256=Ysh5Dk2QFBhXQerArjKdt7xZd3JrN5Ho02AaOjH0Nnw,1
 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/settings_tools.py,sha256=o11W3T60UZSvCTkh_eEQq1Mx74GycQ6JxUr0plBDbsk,2356
+fmtr/tools/settings_tools.py,sha256=Uq1-Cdzz83I4dmr62K0L4xFUsUqp0uDI9SeYCa6EHc0,2426
 fmtr/tools/spaces_tools.py,sha256=D_he3mve6DruB3OPS6QyzqD05ChHnRTb4buViKPe7To,1099
 fmtr/tools/string_tools.py,sha256=ZKHBrl2tui9VjWt7qit4UWbvpuzY6zp5ytiQvhlJVG4,5610
 fmtr/tools/tabular_tools.py,sha256=mw6vOij1Ch-pVAyHMPtm5zj__ULZN_TKeBYOfj33wFM,1634
 fmtr/tools/tokenization_tools.py,sha256=me-IBzSLyNYejLybwjO9CNB6Mj2NYfKPaOVThXyaGNg,4268
 fmtr/tools/tools.py,sha256=sLMXk8juOL8_n_D776cJ-kzjyMHqFI_fctDEjy6PIKs,1115
 fmtr/tools/unicode_tools.py,sha256=yS_9wpu8ogNoiIL7s1G_8bETFFO_YQlo4LNPv1NLDeY,52
-fmtr/tools/version,sha256=EAFGJKF2ntHAJlv_mAXqigAu1JKLkQdZZFpYL7Vh3p0,6
+fmtr/tools/version,sha256=NsbF2x120gFOktRo0UW0oi60P8h7eq7HQIUtLO66Zy8,6
 fmtr/tools/webhook_tools.py,sha256=q3pVJ1NCem2SrMuFcLxiWd7DibFs7Q-uGtojfXd3Qcg,380
 fmtr/tools/yaml_tools.py,sha256=Bhhyd6GQVKO72Lp8ky7bAUjIB_65Hdh0Q45SKIEe6S8,1901
 fmtr/tools/ai_tools/__init__.py,sha256=O8VRlPnnQCncg2ZZ2l_VdWLJf4jkKH6dkZFVbv6o7IM,388
@@ -74,7 +74,7 @@ fmtr/tools/path_tools/app_path_tools.py,sha256=JrJvtTDd_gkCKcZtBCDTMktsM77PZwGV_
 fmtr/tools/path_tools/path_tools.py,sha256=s3RTXsjnr2Ah7vXQGjpGs-4DlWaVGvChu0aTFXX3gsE,8867
 fmtr/tools/path_tools/type_path_tools.py,sha256=Zgs-ek-GXRKDIlVDGdg3muB0PIxTg2ba0NeHw6y8FWQ,40
 fmtr/tools/setup_tools/__init__.py,sha256=Ro_Qj3Xndv8Z68DeWPI7c6X-aWKsdDm0KcX_k1xDhgE,394
-fmtr/tools/setup_tools/setup_tools.py,sha256=7Z6jlU6UE8P4cntGQ_hJR7hGvoqwh15xzZY63cnxG7E,10363
+fmtr/tools/setup_tools/setup_tools.py,sha256=ykW7rAv6ixfXdmLKcPgotenEQ94-NSsdFnDUZqgRbpI,10956
 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
@@ -85,9 +85,9 @@ fmtr/tools/tests/test_path.py,sha256=AkZQa6_8BQ-VaCyL_J-iKmdf2ZaM-xFYR37Kun3k4_g
 fmtr/tools/tests/test_yaml.py,sha256=jc0TwwKu9eC0LvFGNMERdgBue591xwLxYXFbtsRwXVM,287
 fmtr/tools/version_tools/__init__.py,sha256=cjE6nO6AoVOUp3RwgTbqL9wiw8J1l2pHJOz6Gn6bxjA,326
 fmtr/tools/version_tools/version_tools.py,sha256=Hcc6yferZS1hHbugRTdiHhSNmXEEG0hjCiTTXKna-YY,1127
-fmtr_tools-1.3.75.dist-info/licenses/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
-fmtr_tools-1.3.75.dist-info/METADATA,sha256=tc0dLbu9SrTc1jlpcDdW3c6g1z4QtzdRyLnk0VMVwe4,18035
-fmtr_tools-1.3.75.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fmtr_tools-1.3.75.dist-info/entry_points.txt,sha256=h-r__Xh5njtFqreMLg6cGuTFS4Qh-QqJPU1HB-_BS-Q,357
-fmtr_tools-1.3.75.dist-info/top_level.txt,sha256=LXem9xCgNOD72tE2gRKESdiQTL902mfFkwWb6-dlwEE,5
-fmtr_tools-1.3.75.dist-info/RECORD,,
+fmtr_tools-1.3.76.dist-info/licenses/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
+fmtr_tools-1.3.76.dist-info/METADATA,sha256=qceqhfyIUdA5X0mZdsbNpOg2f59Mk_W0zxEiulcydIs,17916
+fmtr_tools-1.3.76.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fmtr_tools-1.3.76.dist-info/entry_points.txt,sha256=h-r__Xh5njtFqreMLg6cGuTFS4Qh-QqJPU1HB-_BS-Q,357
+fmtr_tools-1.3.76.dist-info/top_level.txt,sha256=LXem9xCgNOD72tE2gRKESdiQTL902mfFkwWb6-dlwEE,5
+fmtr_tools-1.3.76.dist-info/RECORD,,