fmtr.tools 1.2.7__py3-none-any.whl → 1.3.0__py3-none-any.whl

fmtr/tools/dns_tools/server.py

@@ -66,7 +66,7 @@ class ServerBaseDoHProxy(ServerBasePlain):
 
         request = exchange.request
 
-        with logger.span(f'Handling request for {request.name_text} from {exchange.client}...'):
+        with logger.span(f'Handling request ID {request.message.id} for {request.name_text} from {exchange.client}...'):
 
             if not request.is_valid:
                 raise ValueError(f'Only one question per request is supported. Got {len(request.question)} questions.')

fmtr/tools/setup_tools/setup_tools.py

@@ -3,7 +3,7 @@ from datetime import datetime
 from fnmatch import fnmatch
 from functools import cached_property
 from itertools import chain
-from typing import List, Dict
+from typing import List, Dict, Any, Callable, Optional
 
 from fmtr.tools.constants import Constants
 from fmtr.tools.path_tools import Path
@@ -18,7 +18,6 @@ class SetupPaths(FromCallerMixin):
     """
 
     def __init__(self, path=None, org=Constants.ORG_NAME):
-
         """
 
         Use calling module path as default path, if not otherwise specified.
@@ -31,15 +30,30 @@ class SetupPaths(FromCallerMixin):
         self.repo = Path(path)
 
     @property
-    def readme(self):
+    def readme(self) -> Path:
+        """
+
+        Path of the README file.
+
+        """
         return self.repo / 'README.md'
 
     @property
-    def version(self):
+    def version(self) -> Path:
+        """
+
+        Path of the version file
+
+        """
         return self.path / Constants.FILENAME_VERSION
 
     @cached_property
-    def path(self):
+    def path(self) -> Path:
+        """
+
+        Infer the package path. It should be the only non-excluded package in the repo/org Path.
+
+        """
 
         if self.is_namespace:
             base = self.org
@@ -61,7 +75,12 @@ class SetupPaths(FromCallerMixin):
         return package
 
     @property
-    def org(self):
+    def org(self) -> bool | Path:
+        """
+
+        Get the org path, i.e. the namespace parent directory.
+
+        """
         if not self.org_name:
             return False
         org = self.repo / self.org_name
@@ -70,7 +89,12 @@ class SetupPaths(FromCallerMixin):
         return org
 
     @property
-    def entrypoints(self):
+    def entrypoints(self) -> Path:
+        """
+
+        Path of entrypoints sub-package.
+
+        """
         return self.path / Constants.ENTRYPOINTS_DIR
 
     @property
@@ -83,6 +107,11 @@ class SetupPaths(FromCallerMixin):
 
 
 class Setup(FromCallerMixin):
+    """
+
+    Abstract canonical pacakge setup for setuptools.
+
+    """
     AUTHOR = 'Frontmatter'
     AUTHOR_EMAIL = 'innovative.fowler@mask.pro.fmtr.dev'
 
@@ -93,8 +122,12 @@ class Setup(FromCallerMixin):
     ENTRYPOINT_FUNC_NAME = 'main'
 
     def __init__(self, dependencies, paths=None, org=Constants.ORG_NAME, client=None, do_setup=True, **kwargs):
+        """
 
+        First check if commandline arguments for requirements output exist. If so, print them and return early.
+        Otherwise, continue generating data to pass to setuptools.
 
+        """
         self.kwargs = kwargs
 
         if type(dependencies) is not Dependencies:
@@ -115,11 +148,15 @@ class Setup(FromCallerMixin):
 
         self.client = client
 
-
         if do_setup:
             self.setup()
 
-    def get_requirements_extras(self):
+    def get_requirements_extras(self) -> Optional[List[str]]:
+        """
+
+        Get list of extras from command line arguments.
+
+        """
         if self.REQUIREMENTS_ARG not in sys.argv:
             return None
 
@@ -128,6 +165,11 @@ class Setup(FromCallerMixin):
         return extras
 
     def print_requirements(self):
+        """
+
+        Output flat list of requirements for specified extras
+
+        """
         reqs = []
         reqs += self.dependencies.install
 
@@ -137,12 +179,17 @@ class Setup(FromCallerMixin):
         print(reqs)
 
     @property
-    def console_scripts(self):
+    def console_scripts(self) -> List[str]:
+        """
+
+        Generate console scripts for any modules in the `entrypoints` sub-package.
+
+        """
 
         if not self.paths.entrypoints.exists():
-            return {}
+            return []
 
-        names_mods = [path.stem for path in self.paths.entrypoints.iterdir() if path.is_file() and not path.stem.startswith('_')]
+        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)
         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]
@@ -153,35 +200,63 @@ class Setup(FromCallerMixin):
         return console_scripts
 
     @property
-    def name(self):
+    def name(self) -> str:
+        """
+
+        Full library name
+
+        """
         if self.paths.is_namespace:
             return f'{self.paths.org_name}.{self.paths.name}'
         return self.paths.name
 
     @property
-    def author(self):
+    def author(self) -> str:
+        """
+
+        Create appropriate author string
+
+        """
         if self.client:
             return f'{self.AUTHOR} on behalf of {self.client}'
         return self.AUTHOR
 
     @property
-    def copyright(self):
+    def copyright(self) -> str:
+        """
+
+        Create appropriate copyright string
+
+        """
         if self.client:
             return self.client
         return self.AUTHOR
 
     @property
-    def long_description(self):
+    def long_description(self) -> str:
+        """
+
+        Read in README.md
 
+        """
         return self.paths.readme.read_text()
 
     @property
-    def version(self):
+    def version(self) -> str:
+        """
+
+        Read in the version string from file
+
+        """
         return self.paths.version.read_text().strip()
 
     @property
-    def find(self):
+    def find(self) -> Callable:
+        """
+
+        Use the appropriate package finding function from setuptools
 
+        """
         from fmtr.tools import setup
 
         if self.paths.is_namespace:
@@ -190,13 +265,23 @@ class Setup(FromCallerMixin):
             return setup.find_packages
 
     @property
-    def packages(self):
+    def packages(self) -> List[str]:
+        """
+
+        Fetch list of packages excluding canonical paths
+
+        """
         excludes = list(Constants.PACKAGE_EXCLUDE_DIRS) + [f'{name}.*' for name in Constants.PACKAGE_EXCLUDE_DIRS if '*' not in name]
         packages = self.find(where=str(self.paths.repo), exclude=excludes)
         return packages
 
     @property
     def package_dir(self):
+        """
+
+        Needs to be relative apparently as absolute paths break during packaging
+
+        """
         if self.paths.is_namespace:
             return {'': '.'}
         else:
@@ -204,14 +289,29 @@ class Setup(FromCallerMixin):
 
     @property
     def package_data(self):
+        """
+
+        Default package data is just the version file
+
+        """
         return {self.name: [Constants.FILENAME_VERSION]}
 
     @property
-    def url(self):
-        return f'https://github.com/{self.org}/{self.paths.name}'
+    def url(self) -> str:
+        """
+
+        Default to GitHub URL
+
+        """
+        return f'https://github.com/{self.org}/{self.name}'
 
     @property
-    def data(self):
+    def data(self) -> Dict[str, Any]:
+        """
+
+        Generate data for use by setuptools
+
+        """
         data = dict(
             name=self.name,
             version=self.version,
@@ -233,13 +333,30 @@ class Setup(FromCallerMixin):
         return data
 
     def setup(self):
+        """
+
+        Call setuptools.setup using generated data
+
+        """
 
         from fmtr.tools import setup
 
         return setup.setup_setuptools(**self.data)
 
+    def __repr__(self) -> str:
+        """
+
+        Show library name
+
+        """
+        return f'{self.__class__.__name__}("{self.name}")'
 
 class Tools:
+    """
+
+    Helper for downstream libraries to specify lists of `fmtr.tools` extras
+
+    """
     MASK = f'{Constants.LIBRARY_NAME}[{{extras}}]'
 
     def __init__(self, *extras):
@@ -261,7 +378,7 @@ class Dependencies:
     def resolve_values(self, key) -> List[str]:
         """
 
-        Flatten a list of values.
+        Flatten a list of dependencies.
 
         """
         values_resolved = []
@@ -290,7 +407,12 @@ class Dependencies:
         return resolved
 
     @cached_property
-    def install(self):
+    def install(self) -> List[str]:
+        """
+
+        Get install_requires
+
+        """
         if self.INSTALL in self.dependencies:
             return self.resolve_values(self.INSTALL)
         else:
@@ -298,26 +420,4 @@ class Dependencies:
 
 
 if __name__ == '__main__':
-    ds = Dependencies(
-        install=['version', 'yaml'],
-
-        yaml=['yamlscript', 'pyyaml'],
-        logging=['logfire', 'version'],
-        version=['semver', 'av'],
-        av=['av']
-        # Add the rest of your dependencies...
-    )
-
-    ds
-
-    setup = Setup(
-        # client='Acme',
-        dependencies=ds,
-        description='some tools test',
-        console_scripts=dict(
-            cache_hfh='console_script_tools',
-            test=None,
-        )
-    )
-    data = setup.get_data_setup()
-    data
+    ...

fmtr/tools/version

@@ -1 +1 @@
-1.2.7
+1.3.0

{fmtr_tools-1.2.7.dist-info → fmtr_tools-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fmtr.tools
-Version: 1.2.7
+Version: 1.3.0
 Summary: Collection of high-level tools to simplify everyday development tasks, with a focus on AI/ML
 Home-page: https://github.com/fmtr/tools
 Author: Frontmatter
@@ -130,60 +130,60 @@ Requires-Dist: logfire[httpx]; extra == "http"
 Provides-Extra: setup
 Requires-Dist: setuptools; extra == "setup"
 Provides-Extra: all
-Requires-Dist: torchvision; extra == "all"
+Requires-Dist: tokenizers; extra == "all"
+Requires-Dist: flet-webview; extra == "all"
+Requires-Dist: logfire; extra == "all"
+Requires-Dist: flet-video; extra == "all"
+Requires-Dist: logfire[httpx]; extra == "all"
+Requires-Dist: pydantic-settings; extra == "all"
+Requires-Dist: ollama; extra == "all"
+Requires-Dist: setuptools; extra == "all"
 Requires-Dist: docker; extra == "all"
-Requires-Dist: yamlscript; extra == "all"
-Requires-Dist: google-auth; extra == "all"
-Requires-Dist: pydevd-pycharm; extra == "all"
-Requires-Dist: html2text; extra == "all"
-Requires-Dist: dask[bag]; extra == "all"
-Requires-Dist: pydantic-ai[logfire,openai]; extra == "all"
+Requires-Dist: regex; extra == "all"
 Requires-Dist: json_repair; extra == "all"
-Requires-Dist: pyyaml; extra == "all"
-Requires-Dist: dnspython[doh]; extra == "all"
+Requires-Dist: pandas; extra == "all"
+Requires-Dist: google-api-python-client; extra == "all"
+Requires-Dist: google-auth-httplib2; extra == "all"
+Requires-Dist: httpx; extra == "all"
+Requires-Dist: tabulate; extra == "all"
+Requires-Dist: uvicorn[standard]; extra == "all"
+Requires-Dist: bokeh; extra == "all"
+Requires-Dist: peft; extra == "all"
+Requires-Dist: html2text; extra == "all"
+Requires-Dist: flet[all]; extra == "all"
 Requires-Dist: contexttimer; extra == "all"
-Requires-Dist: transformers[sentencepiece]; extra == "all"
-Requires-Dist: filetype; extra == "all"
-Requires-Dist: Unidecode; extra == "all"
 Requires-Dist: pymupdf4llm; extra == "all"
-Requires-Dist: flet-webview; extra == "all"
-Requires-Dist: httpx_retries; extra == "all"
-Requires-Dist: sentence_transformers; extra == "all"
-Requires-Dist: tokenizers; extra == "all"
-Requires-Dist: bokeh; extra == "all"
 Requires-Dist: openpyxl; extra == "all"
-Requires-Dist: appdirs; extra == "all"
-Requires-Dist: openai; extra == "all"
-Requires-Dist: sre_yield; extra == "all"
 Requires-Dist: huggingface_hub; extra == "all"
-Requires-Dist: uvicorn[standard]; extra == "all"
-Requires-Dist: fastapi; extra == "all"
-Requires-Dist: deepmerge; extra == "all"
-Requires-Dist: tabulate; extra == "all"
-Requires-Dist: pydantic-settings; extra == "all"
+Requires-Dist: pydantic-ai[logfire,openai]; extra == "all"
 Requires-Dist: pymupdf; extra == "all"
-Requires-Dist: distributed; extra == "all"
-Requires-Dist: faker; extra == "all"
-Requires-Dist: peft; extra == "all"
-Requires-Dist: flet[all]; extra == "all"
-Requires-Dist: httpx; extra == "all"
+Requires-Dist: google-auth; extra == "all"
+Requires-Dist: pydantic; extra == "all"
+Requires-Dist: dask[bag]; extra == "all"
+Requires-Dist: torchaudio; extra == "all"
+Requires-Dist: sentence_transformers; extra == "all"
+Requires-Dist: dnspython[doh]; extra == "all"
 Requires-Dist: semver; extra == "all"
+Requires-Dist: filetype; extra == "all"
+Requires-Dist: pytest-cov; extra == "all"
+Requires-Dist: sre_yield; extra == "all"
+Requires-Dist: openai; extra == "all"
+Requires-Dist: transformers[sentencepiece]; extra == "all"
+Requires-Dist: distributed; extra == "all"
+Requires-Dist: torchvision; extra == "all"
+Requires-Dist: google-auth-oauthlib; extra == "all"
+Requires-Dist: Unidecode; extra == "all"
+Requires-Dist: httpx_retries; extra == "all"
 Requires-Dist: tinynetrc; extra == "all"
-Requires-Dist: google-auth-httplib2; extra == "all"
-Requires-Dist: logfire; extra == "all"
-Requires-Dist: google-api-python-client; extra == "all"
-Requires-Dist: pydantic; extra == "all"
+Requires-Dist: yamlscript; extra == "all"
+Requires-Dist: pyyaml; extra == "all"
+Requires-Dist: appdirs; extra == "all"
 Requires-Dist: logfire[fastapi]; extra == "all"
-Requires-Dist: ollama; extra == "all"
-Requires-Dist: pandas; extra == "all"
+Requires-Dist: pydevd-pycharm; extra == "all"
+Requires-Dist: deepmerge; extra == "all"
+Requires-Dist: faker; extra == "all"
+Requires-Dist: fastapi; extra == "all"
 Requires-Dist: diskcache; extra == "all"
-Requires-Dist: logfire[httpx]; extra == "all"
-Requires-Dist: regex; extra == "all"
-Requires-Dist: google-auth-oauthlib; extra == "all"
-Requires-Dist: pytest-cov; extra == "all"
-Requires-Dist: setuptools; extra == "all"
-Requires-Dist: torchaudio; extra == "all"
-Requires-Dist: flet-video; extra == "all"
 Dynamic: author
 Dynamic: author-email
 Dynamic: description

{fmtr_tools-1.2.7.dist-info → fmtr_tools-1.3.0.dist-info}/RECORD

@@ -44,7 +44,7 @@ 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=5xFfItk8jmF4J6XXD2GJpvj_7M8dldsmM0Uqpe1aihs,5
+fmtr/tools/version,sha256=WSltI9YjzgrfdnXSIVboOxJIyFCBNaZd2KnjjEl-lKg,5
 fmtr/tools/version_tools.py,sha256=yNs_CGqWpqE4jbK9wsPIi14peJVXYbhIcMqHAFOw3yE,1480
 fmtr/tools/yaml_tools.py,sha256=9kuYChqJelWQIjGlSnK4iDdOWWH06P0gp9jIcRrC3UI,1903
 fmtr/tools/ai_tools/__init__.py,sha256=JZrLuOFNV1A3wvJgonxOgz_4WS-7MfCuowGWA5uYCjs,372
@@ -53,7 +53,7 @@ fmtr/tools/ai_tools/inference_tools.py,sha256=2UP2gXEyOJUjyyV6zmFIYmIxUsh1rXkRH0
 fmtr/tools/dns_tools/__init__.py,sha256=PwHxnpiy6_isQfUmz_5V1hL0dcPaA6ItqvoGWW8MOfk,222
 fmtr/tools/dns_tools/client.py,sha256=omHdk9bA_8u2-VMQhh0c9r9e-oG4mZ0MWA9lfbtSEIc,2371
 fmtr/tools/dns_tools/dm.py,sha256=mvXacq6QJ86G0S0tkzJFhU7bOaSJytvsMNlxs5X9hfE,2236
-fmtr/tools/dns_tools/server.py,sha256=hSZhK4EZD6Ox4uRI3ldbnyyZf6DYgMUcTfffbrZN5pk,2329
+fmtr/tools/dns_tools/server.py,sha256=X6-4pC8u5BG_BnOHTPcmkT3455Cd10CddwrDUYrGUOw,2353
 fmtr/tools/entrypoints/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fmtr/tools/entrypoints/cache_hfh.py,sha256=fQNs4J9twQuZH_Yj98-oOvEX7-LrSUP3kO8nzw2HrHs,60
 fmtr/tools/entrypoints/ep_test.py,sha256=B8HfWISfSgw_xVX475CbJGh_QnpOe9MH65H8qGjTWbY,46
@@ -64,7 +64,7 @@ fmtr/tools/path_tools/app_path_tools.py,sha256=JrJvtTDd_gkCKcZtBCDTMktsM77PZwGV_
 fmtr/tools/path_tools/path_tools.py,sha256=8WBzNctpds5tVT1-FcizAORrBCGlkUbPcfOel-Js7ps,7878
 fmtr/tools/path_tools/type_path_tools.py,sha256=Zgs-ek-GXRKDIlVDGdg3muB0PIxTg2ba0NeHw6y8FWQ,40
 fmtr/tools/setup_tools/__init__.py,sha256=fUCjzyE4JBPEOZhC4B--VPj_eOCkQb1QG5PIgiGj03U,386
-fmtr/tools/setup_tools/setup_tools.py,sha256=7hmokqtgT1eeptSY8m5Vy5V2piQv9DU5oLWAO05k4PA,8545
+fmtr/tools/setup_tools/setup_tools.py,sha256=7Z6jlU6UE8P4cntGQ_hJR7hGvoqwh15xzZY63cnxG7E,10363
 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
@@ -73,9 +73,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.2.7.dist-info/licenses/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
-fmtr_tools-1.2.7.dist-info/METADATA,sha256=3bmhaXPzz8Yt1zSVrOBrOU2i2kvwIwObkBpcP1rfRwE,16025
-fmtr_tools-1.2.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fmtr_tools-1.2.7.dist-info/entry_points.txt,sha256=fSQrDGNctdQXbUxpMWYVfVQ0mhZMDyaEDG3D3a0zOSc,278
-fmtr_tools-1.2.7.dist-info/top_level.txt,sha256=LXem9xCgNOD72tE2gRKESdiQTL902mfFkwWb6-dlwEE,5
-fmtr_tools-1.2.7.dist-info/RECORD,,
+fmtr_tools-1.3.0.dist-info/licenses/LICENSE,sha256=FW9aa6vVN5IjRQWLT43hs4_koYSmpcbIovlKeAJ0_cI,10757
+fmtr_tools-1.3.0.dist-info/METADATA,sha256=-R7R2iLGtkCyDxaQtfFl2gjeiyw6NmZEiG2OPxcqM0Q,16025
+fmtr_tools-1.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fmtr_tools-1.3.0.dist-info/entry_points.txt,sha256=fSQrDGNctdQXbUxpMWYVfVQ0mhZMDyaEDG3D3a0zOSc,278
+fmtr_tools-1.3.0.dist-info/top_level.txt,sha256=LXem9xCgNOD72tE2gRKESdiQTL902mfFkwWb6-dlwEE,5
+fmtr_tools-1.3.0.dist-info/RECORD,,