fmtr.tools 1.0.54__tar.gz → 1.1.0__tar.gz

{fmtr.tools-1.0.54 → fmtr_tools-1.1.0}/PKG-INFO

@@ -1,43 +1,161 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: fmtr.tools
-Version: 1.0.54
+Version: 1.1.0
 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
 Author-email: innovative.fowler@mask.pro.fmtr.dev
 License: Copyright © 2025 Frontmatter. All rights reserved.
 Description-Content-Type: text/markdown
-Provides-Extra: ai
-Provides-Extra: ai.client
-Provides-Extra: api
-Provides-Extra: augmentation
-Provides-Extra: caching
-Provides-Extra: debug
-Provides-Extra: dm
-Provides-Extra: docker.api
-Provides-Extra: google.api
-Provides-Extra: hfh
-Provides-Extra: html
-Provides-Extra: interface
-Provides-Extra: json-fix
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: flet-webview; extra == "test"
+Requires-Dist: uvicorn; extra == "test"
+Requires-Dist: pymupdf4llm; extra == "test"
+Requires-Dist: pyyaml; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: logfire; extra == "test"
+Requires-Dist: google-auth-httplib2; extra == "test"
+Requires-Dist: tinynetrc; extra == "test"
+Requires-Dist: sre_yield; extra == "test"
+Requires-Dist: bokeh; extra == "test"
+Requires-Dist: html2text; extra == "test"
+Requires-Dist: sentence_transformers; extra == "test"
+Requires-Dist: docker; extra == "test"
+Requires-Dist: peft; extra == "test"
+Requires-Dist: google-auth; extra == "test"
+Requires-Dist: fastapi; extra == "test"
+Requires-Dist: pydantic; extra == "test"
+Requires-Dist: pydantic-settings; extra == "test"
+Requires-Dist: pydantic-ai[logfire,openai]; extra == "test"
+Requires-Dist: torchvision; extra == "test"
+Requires-Dist: google-api-python-client; extra == "test"
+Requires-Dist: distributed; extra == "test"
+Requires-Dist: openpyxl; extra == "test"
+Requires-Dist: contexttimer; extra == "test"
+Requires-Dist: huggingface_hub; extra == "test"
+Requires-Dist: dask[bag]; extra == "test"
+Requires-Dist: tabulate; extra == "test"
+Requires-Dist: tokenizers; extra == "test"
+Requires-Dist: ollama; extra == "test"
+Requires-Dist: pandas; extra == "test"
+Requires-Dist: flet-video; extra == "test"
+Requires-Dist: flet[all]; extra == "test"
+Requires-Dist: transformers[sentencepiece]; extra == "test"
+Requires-Dist: semver; extra == "test"
+Requires-Dist: openai; extra == "test"
+Requires-Dist: google-auth-oauthlib; extra == "test"
+Requires-Dist: pydevd-pycharm; extra == "test"
+Requires-Dist: faker; extra == "test"
+Requires-Dist: pymupdf; extra == "test"
+Requires-Dist: deepmerge; extra == "test"
+Requires-Dist: diskcache; extra == "test"
+Requires-Dist: json_repair; extra == "test"
+Requires-Dist: Unidecode; extra == "test"
+Requires-Dist: torchaudio; extra == "test"
+Provides-Extra: yaml
+Requires-Dist: pyyaml; extra == "yaml"
 Provides-Extra: logging
-Provides-Extra: merging
-Provides-Extra: metric
-Provides-Extra: netrc
-Provides-Extra: openai.api
+Requires-Dist: logfire; extra == "logging"
+Requires-Dist: semver; extra == "logging"
 Provides-Extra: parallel
-Provides-Extra: pdf
+Requires-Dist: dask[bag]; extra == "parallel"
+Requires-Dist: distributed; extra == "parallel"
+Requires-Dist: bokeh; extra == "parallel"
+Provides-Extra: tokenization
+Requires-Dist: tokenizers; extra == "tokenization"
+Provides-Extra: augmentation
+Requires-Dist: faker; extra == "augmentation"
+Requires-Dist: sre_yield; extra == "augmentation"
 Provides-Extra: process
+Requires-Dist: logfire; extra == "process"
+Requires-Dist: semver; extra == "process"
 Provides-Extra: profiling
-Provides-Extra: semantic
-Provides-Extra: spaces
-Provides-Extra: tabular
-Provides-Extra: test
-Provides-Extra: tokenization
+Requires-Dist: contexttimer; extra == "profiling"
+Provides-Extra: docker-api
+Requires-Dist: docker; extra == "docker-api"
 Provides-Extra: unicode
+Requires-Dist: Unidecode; extra == "unicode"
 Provides-Extra: version
-Provides-Extra: yaml
-License-File: LICENSE
+Requires-Dist: semver; extra == "version"
+Provides-Extra: spaces
+Requires-Dist: tinynetrc; extra == "spaces"
+Provides-Extra: netrc
+Requires-Dist: tinynetrc; extra == "netrc"
+Provides-Extra: hfh
+Requires-Dist: huggingface_hub; extra == "hfh"
+Provides-Extra: merging
+Requires-Dist: deepmerge; extra == "merging"
+Provides-Extra: api
+Requires-Dist: fastapi; extra == "api"
+Requires-Dist: uvicorn; extra == "api"
+Requires-Dist: logfire; extra == "api"
+Requires-Dist: semver; extra == "api"
+Requires-Dist: pydantic; extra == "api"
+Provides-Extra: ai
+Requires-Dist: peft; extra == "ai"
+Requires-Dist: transformers[sentencepiece]; extra == "ai"
+Requires-Dist: torchvision; extra == "ai"
+Requires-Dist: torchaudio; extra == "ai"
+Requires-Dist: pydantic; extra == "ai"
+Provides-Extra: dm
+Requires-Dist: pydantic; extra == "dm"
+Provides-Extra: openai-api
+Requires-Dist: openai; extra == "openai-api"
+Provides-Extra: ai-client
+Requires-Dist: logfire; extra == "ai-client"
+Requires-Dist: semver; extra == "ai-client"
+Requires-Dist: pydantic; extra == "ai-client"
+Requires-Dist: openai; extra == "ai-client"
+Requires-Dist: pydantic-ai[logfire,openai]; extra == "ai-client"
+Requires-Dist: ollama; extra == "ai-client"
+Provides-Extra: json-fix
+Requires-Dist: json_repair; extra == "json-fix"
+Provides-Extra: semantic
+Requires-Dist: sentence_transformers; extra == "semantic"
+Requires-Dist: pandas; extra == "semantic"
+Requires-Dist: tabulate; extra == "semantic"
+Requires-Dist: openpyxl; extra == "semantic"
+Provides-Extra: metric
+Requires-Dist: pandas; extra == "metric"
+Requires-Dist: tabulate; extra == "metric"
+Requires-Dist: openpyxl; extra == "metric"
+Provides-Extra: tabular
+Requires-Dist: pandas; extra == "tabular"
+Requires-Dist: tabulate; extra == "tabular"
+Requires-Dist: openpyxl; extra == "tabular"
+Provides-Extra: html
+Requires-Dist: html2text; extra == "html"
+Provides-Extra: interface
+Requires-Dist: flet[all]; extra == "interface"
+Requires-Dist: flet-video; extra == "interface"
+Requires-Dist: flet-webview; extra == "interface"
+Requires-Dist: pydantic; extra == "interface"
+Provides-Extra: google-api
+Requires-Dist: google-auth; extra == "google-api"
+Requires-Dist: google-auth-oauthlib; extra == "google-api"
+Requires-Dist: google-auth-httplib2; extra == "google-api"
+Requires-Dist: google-api-python-client; extra == "google-api"
+Provides-Extra: caching
+Requires-Dist: diskcache; extra == "caching"
+Provides-Extra: pdf
+Requires-Dist: pymupdf; extra == "pdf"
+Requires-Dist: pydantic; extra == "pdf"
+Requires-Dist: pymupdf4llm; extra == "pdf"
+Provides-Extra: debug
+Requires-Dist: pydevd-pycharm; extra == "debug"
+Provides-Extra: sets
+Requires-Dist: pydantic-settings; extra == "sets"
+Requires-Dist: pydantic; extra == "sets"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: summary
 
 # `fmtr.tools`
 
@@ -125,6 +243,10 @@ The included modules, plus any extra requirements, are as follows:
   - Extras: `ai`
 - `tools.config`: Base config class with overridable field processors.
     - Extras: None
+-
+`tools.settings`: A base configuration system built on Pydantic Settings that provides a flexible way to manage application settings from multiple sources, based on a standard
+`path.PackagePaths` project layout.
+  - Extras: `sets`
 - `tools.dataclass`: Utilities for extracting and filtering fields and metadata from dataclasses, with support for applying filters and retrieving enabled fields based on metadata attributes.
     - Extras: None
 - `tools.datatype`
@@ -155,8 +277,12 @@ The included modules, plus any extra requirements, are as follows:
   - Extras: None
 - `tools.openai`: Utilities for interacting with the OpenAI API, simple text-to-text output, etc.
   - Extras: `openai.api`
-- `tools.Path`: Enhanced `pathlib.Path` object with additional functionality for Windows-to-Unix path conversion, reading/writing JSON and YAML files, and convenient directory creation with parent directories. Includes methods for obtaining paths to modules and temporary directories.
+- `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.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.0.54 → fmtr_tools-1.1.0}/README.md

@@ -84,6 +84,10 @@ The included modules, plus any extra requirements, are as follows:
   - Extras: `ai`
 - `tools.config`: Base config class with overridable field processors.
     - Extras: None
+-
+`tools.settings`: A base configuration system built on Pydantic Settings that provides a flexible way to manage application settings from multiple sources, based on a standard
+`path.PackagePaths` project layout.
+  - Extras: `sets`
 - `tools.dataclass`: Utilities for extracting and filtering fields and metadata from dataclasses, with support for applying filters and retrieving enabled fields based on metadata attributes.
     - Extras: None
 - `tools.datatype`
@@ -114,8 +118,12 @@ The included modules, plus any extra requirements, are as follows:
   - Extras: None
 - `tools.openai`: Utilities for interacting with the OpenAI API, simple text-to-text output, etc.
   - Extras: `openai.api`
-- `tools.Path`: Enhanced `pathlib.Path` object with additional functionality for Windows-to-Unix path conversion, reading/writing JSON and YAML files, and convenient directory creation with parent directories. Includes methods for obtaining paths to modules and temporary directories.
+- `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.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.0.54 → fmtr_tools-1.1.0}/fmtr/tools/__init__.py

@@ -2,7 +2,7 @@ from fmtr.tools import version_tools as version
 
 __version__ = version.read()
 
-import fmtr.tools.config_tools as config
+
 import fmtr.tools.dataclass_tools as dataclass
 import fmtr.tools.datatype_tools as datatype
 import fmtr.tools.environment_tools as env
@@ -22,7 +22,8 @@ import fmtr.tools.async_tools as asyncio
 from fmtr.tools.logging_tools import logger
 
 from fmtr.tools.import_tools import MissingExtraMockModule
-from fmtr.tools.path_tools import Path
+from fmtr.tools.path_tools import Path, PackagePaths
+from fmtr.tools.constants import Constants
 
 try:
     from fmtr.tools import augmentation_tools as augmentation
@@ -158,9 +159,13 @@ try:
 except ImportError as exception:
     debug = MissingExtraMockModule('debug', exception)
 
+try:
+    from fmtr.tools import settings_tools as sets
+except ImportError as exception:
+    sets = MissingExtraMockModule('sets', exception)
+
 
 __all__ = [
-    'config',
     'dataclass',
     'datatype',
     'environment',

{fmtr.tools-1.0.54 → fmtr_tools-1.1.0}/fmtr/tools/ai_tools/agentic_tools.py

@@ -6,7 +6,7 @@ from pydantic_ai.models.openai import OpenAIModel
 from pydantic_ai.providers.openai import OpenAIProvider
 
 from fmtr.tools import environment_tools as env
-from fmtr.tools.config import ToolsConfig
+from fmtr.tools.constants import Constants
 
 pydantic_ai.Agent.instrument_all()
 
@@ -17,9 +17,9 @@ class Task:
 
     """
 
-    PROVIDER = OpenAIProvider(api_key=env.get(ToolsConfig.FMTR_OPENAI_API_KEY_KEY))
+    PROVIDER = OpenAIProvider(api_key=env.get(Constants.FMTR_OPENAI_API_KEY_KEY))
 
-    API_HOST_FMTR = env.get(ToolsConfig.FMTR_AI_HOST_KEY, ToolsConfig.FMTR_AI_HOST_DEFAULT)
+    API_HOST_FMTR = env.get(Constants.FMTR_AI_HOST_KEY, Constants.FMTR_AI_HOST_DEFAULT)
     API_URL_FMTR = f'https://{API_HOST_FMTR}/v1'
     PROVIDER_FMTR = OpenAIProvider(base_url=API_URL_FMTR)
 

fmtr.tools-1.0.54/fmtr/tools/config.py → fmtr_tools-1.1.0/fmtr/tools/constants.py

@@ -1,9 +1,7 @@
 import datetime
 
-from fmtr.tools.config_tools import ConfigClass
 
-
-class ToolsConfig(ConfigClass):
+class Constants:
     ENCODING = 'UTF-8'
     ORG_NAME = 'fmtr'
     LIBRARY_NAME = f'{ORG_NAME}.tools'

{fmtr.tools-1.0.54 → fmtr_tools-1.1.0}/fmtr/tools/debugging_tools.py

@@ -1,7 +1,7 @@
 import pydevd_pycharm
 
 from fmtr.tools import environment_tools as env
-from fmtr.tools.config import ToolsConfig
+from fmtr.tools.constants import Constants
 
 MASK = 'Starting debugger at tcp://{host}:{port}...'
 
@@ -12,16 +12,16 @@ def trace(is_debug=None, host=None, port=None, stdoutToServer=True, stderrToServ
 
     """
     if not is_debug:
-        is_debug = env.get_bool(ToolsConfig.FMTR_REMOTE_DEBUG_ENABLED_KEY, False)
+        is_debug = env.get_bool(Constants.FMTR_REMOTE_DEBUG_ENABLED_KEY, False)
 
     if not is_debug:
         return
 
     if is_debug is True and not host:
-        host = ToolsConfig.FMTR_REMOTE_DEBUG_HOST_DEFAULT
+        host = Constants.FMTR_REMOTE_DEBUG_HOST_DEFAULT
 
-    host = host or env.get(ToolsConfig.FMTR_REMOTE_DEBUG_HOST_KEY, ToolsConfig.FMTR_REMOTE_DEBUG_HOST_DEFAULT)
-    port = port or ToolsConfig.FMTR_REMOTE_DEBUG_PORT_DEFAULT
+    host = host or env.get(Constants.FMTR_REMOTE_DEBUG_HOST_KEY, Constants.FMTR_REMOTE_DEBUG_HOST_DEFAULT)
+    port = port or Constants.FMTR_REMOTE_DEBUG_PORT_DEFAULT
 
     from fmtr.tools import logger
 

{fmtr.tools-1.0.54 → fmtr_tools-1.1.0}/fmtr/tools/environment_tools.py

@@ -8,7 +8,7 @@ from collections.abc import Callable
 from datetime import date, datetime
 from typing import Any, Dict
 
-from fmtr.tools.config import ToolsConfig
+from fmtr.tools.constants import Constants
 from fmtr.tools.datatype_tools import to_bool
 from fmtr.tools.path_tools import Path
 from fmtr.tools.tools import identity, EMPTY
@@ -76,4 +76,4 @@ get_date = get_getter(date.fromisoformat)
 get_datetime = get_getter(datetime.fromisoformat)
 get_path = get_getter(Path)
 
-IS_DEBUG = get(ToolsConfig.FMTR_LOG_LEVEL_KEY, None, converter=str.upper) == 'DEBUG'
+IS_DEBUG = get(Constants.FMTR_LOG_LEVEL_KEY, None, converter=str.upper) == 'DEBUG'

{fmtr.tools-1.0.54 → fmtr_tools-1.1.0}/fmtr/tools/hash_tools.py

@@ -2,7 +2,7 @@ import base64
 import hashlib
 from zlib import crc32
 
-from fmtr.tools.config import ToolsConfig
+from fmtr.tools.constants import Constants
 
 SPECIALS = {'O': '9', '=': '9', 'I': '9'}
 
@@ -12,7 +12,7 @@ def hash_unit(value: str) -> float:
     Hash the input string to a value between 0.0 and 1.0 (not secure).
 
     """
-    value = str(value).encode(ToolsConfig.ENCODING)
+    value = str(value).encode(Constants.ENCODING)
     return float(crc32(value) & 0xffffffff) / 2 ** 32
 
 

{fmtr.tools-1.0.54 → fmtr_tools-1.1.0}/fmtr/tools/json_tools.py

@@ -1,6 +1,6 @@
 import json
 
-from fmtr.tools.config import ToolsConfig
+from fmtr.tools.constants import Constants
 
 
 def to_json(obj):
@@ -9,7 +9,7 @@ def to_json(obj):
     Serialise to JSON
 
     """
-    json_str = json.dumps(obj, indent=ToolsConfig.SERIALIZATION_INDENT, ensure_ascii=False)
+    json_str = json.dumps(obj, indent=Constants.SERIALIZATION_INDENT, ensure_ascii=False)
     return json_str
 
 

{fmtr.tools-1.0.54 → fmtr_tools-1.1.0}/fmtr/tools/logging_tools.py

@@ -2,7 +2,7 @@ import logging
 import os
 
 from fmtr.tools import environment_tools
-from fmtr.tools.config import ToolsConfig
+from fmtr.tools.constants import Constants
 
 DEVELOPMENT = "development"
 PRODUCTION = "production"
@@ -12,7 +12,7 @@ ENVIRONMENT_DEFAULT = DEVELOPMENT
 LEVEL_DEFAULT = logging.DEBUG if environment_tools.IS_DEBUG else logging.INFO
 
 
-def get_logger(name, version=None, host=ToolsConfig.FMTR_OBS_HOST, key=None, org=ToolsConfig.ORG_NAME,
+def get_logger(name, version=None, host=Constants.FMTR_OBS_HOST, key=None, org=Constants.ORG_NAME,
                stream=STREAM_DEFAULT,
                environment=ENVIRONMENT_DEFAULT, level=LEVEL_DEFAULT):
     """
@@ -31,7 +31,7 @@ def get_logger(name, version=None, host=ToolsConfig.FMTR_OBS_HOST, key=None, org
         return logger
 
     if key is None:
-        key = environment_tools.get(ToolsConfig.FMTR_OBS_API_KEY_KEY)
+        key = environment_tools.get(Constants.FMTR_OBS_API_KEY_KEY)
     url = f"https://{host}/api/{org}/v1/traces"
     headers = f"Authorization=Basic {key},stream-name={stream}"
 
@@ -57,7 +57,7 @@ def get_logger(name, version=None, host=ToolsConfig.FMTR_OBS_HOST, key=None, org
     return logger
 
 
-logger = get_logger(name=ToolsConfig.LIBRARY_NAME)
+logger = get_logger(name=Constants.LIBRARY_NAME)
 
 if __name__ == '__main__':
     logger.info('Hello World')

{fmtr.tools-1.0.54 → fmtr_tools-1.1.0}/fmtr/tools/parallel_tools.py

@@ -6,13 +6,12 @@ from contextlib import nullcontext as NullContext
 from dask.diagnostics import ProgressBar
 from typing import List, Callable, Any, Union
 
-from fmtr.tools.config_tools import ConfigClass
 from fmtr.tools.iterator_tools import dict_records_to_lists
 from fmtr.tools.logging_tools import logger
 from fmtr.tools.path_tools import Path
 
 
-class ParallelConfig(ConfigClass):
+class ParallelConfig:
     """
 
     Configuration values.

{fmtr.tools-1.0.54 → fmtr_tools-1.1.0}/fmtr/tools/path_tools.py

@@ -1,11 +1,10 @@
 import re
 import subprocess
-from inspect import stack
 from pathlib import Path
 from tempfile import gettempdir
 from typing import Union, Any
 
-from fmtr.tools.config import ToolsConfig
+from fmtr.tools.constants import Constants
 from fmtr.tools.platform_tools import is_wsl
 
 WIN_PATH_PATTERN = r'''([a-z]:(\\|$)|\\\\)'''
@@ -72,8 +71,8 @@ class Path(type(Path())):
         Get path to originating module (e.g. directory containing .py file).
 
         """
-        frame_called = stack()[1]
-        path = cls(frame_called.filename).absolute().parent
+        from fmtr.tools.inspection_tools import get_call_path
+        path = get_call_path(offset=2).absolute().parent
         return path
 
     @classmethod
@@ -83,8 +82,8 @@ class Path(type(Path())):
         Get path to originating module (i.e. .py file).
 
         """
-        frame_called = stack()[1]
-        path = cls(frame_called.filename).absolute()
+        from fmtr.tools.inspection_tools import get_call_path
+        path = get_call_path(offset=2).absolute()
         return path
 
     @classmethod
@@ -96,29 +95,6 @@ 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:
         """
 
@@ -127,7 +103,7 @@ class Path(type(Path())):
         """
         from fmtr.tools import json
         json_str = json.to_json(obj)
-        return self.write_text(json_str, encoding=ToolsConfig.ENCODING)
+        return self.write_text(json_str, encoding=Constants.ENCODING)
 
     def read_json(self) -> Any:
         """
@@ -136,7 +112,7 @@ class Path(type(Path())):
 
         """
         from fmtr.tools import json
-        json_str = self.read_text(encoding=ToolsConfig.ENCODING)
+        json_str = self.read_text(encoding=Constants.ENCODING)
         obj = json.from_json(json_str)
         return obj
 
@@ -148,7 +124,7 @@ class Path(type(Path())):
         """
         from fmtr.tools import yaml
         yaml_str = yaml.to_yaml(obj)
-        return self.write_text(yaml_str, encoding=ToolsConfig.ENCODING)
+        return self.write_text(yaml_str, encoding=Constants.ENCODING)
 
     def read_yaml(self) -> Any:
         """
@@ -157,7 +133,7 @@ class Path(type(Path())):
 
         """
         from fmtr.tools import yaml
-        yaml_str = self.read_text(encoding=ToolsConfig.ENCODING)
+        yaml_str = self.read_text(encoding=Constants.ENCODING)
         obj = yaml.from_yaml(yaml_str)
         return obj
 
@@ -170,3 +146,107 @@ class Path(type(Path())):
         return self.mkdir(parents=True, exist_ok=True)
 
 
+class PackagePaths:
+    """
+
+    Canonical paths for a package.
+
+    """
+
+    FILENAME_CONFIG = 'settings.yaml'
+    DIR_NAME_ARTIFACTS = 'artifacts'
+    FILENAME_VERSION = 'version'
+
+    def __init__(self, path=None, org_singleton=None, dir_name_artifacts=DIR_NAME_ARTIFACTS, filename_config=FILENAME_CONFIG, file_version=FILENAME_VERSION):
+
+        """
+
+        Use calling module path as default path, if not otherwise specified.
+
+        """
+        if not path:
+            from fmtr.tools.inspection_tools import get_call_path
+            path = get_call_path(offset=2).parent
+
+        self.path = Path(path)
+        self.org_singleton = org_singleton
+        self.dir_name_artifacts = dir_name_artifacts
+        self.filename_config = filename_config
+        self.filename_version = file_version
+
+    @property
+    def is_namespace(self) -> bool:
+        """
+
+        If organization is not hard-specified, then the package is a namespace.
+
+        """
+        return not bool(self.org_singleton)
+
+    @property
+    def name(self) -> str:
+        """
+
+        Name of package.
+
+        """
+        return self.path.stem
+
+    @property
+    def org(self) -> str:
+        """
+
+        Name of organization.
+
+        """
+        if not self.is_namespace:
+            return self.org_singleton
+        else:
+            return self.path.parent.stem
+
+    @property
+    def repo(self) -> Path:
+        """
+
+        Path of repo (i.e. parent of package base directory).
+
+        """
+        if self.is_namespace:
+            return self.path.parent.parent
+        else:
+            return self.path.parent
+
+    @property
+    def version(self) -> Path:
+        """
+
+        Path of version file.
+
+        """
+        return self.path / self.filename_version
+
+    @property
+    def artifacts(self) -> Path:
+        """
+
+        Path of artifacts directory.
+
+        """
+        return self.repo / self.dir_name_artifacts
+
+    @property
+    def settings(self) -> Path:
+        """
+
+        Path of settings file.
+
+        """
+        return self.artifacts / self.filename_config
+
+    def __repr__(self) -> str:
+        """
+
+        Show base path in repr.
+
+        """
+        return f'{self.__class__.__name__}("{self.path}")'