tiferet 1.0.0a0__py3-none-any.whl

app/repos/error.py

@@ -0,0 +1,173 @@
+# *** imports
+
+# ** core
+from typing import List, Dict
+
+# ** app
+from ..domain.error import Error
+from ..clients import yaml as yaml_client
+from ..data.error import ErrorData
+
+
+# *** repository
+
+# ** interface: error_repository
+class ErrorRepository(object):
+
+    # * method: exists
+    def exists(self, id: str, **kwargs) -> bool:
+        '''
+        Check if the error exists.
+
+        :param id: The error id.
+        :type id: str
+        :param kwargs: Additional keyword arguments.
+        :type kwargs: dict
+        :return: Whether the error exists.
+        :rtype: bool
+        '''
+
+        # Not implemented.
+        raise NotImplementedError()
+
+    # * method: get
+    def get(self, id: str) -> Error:
+        '''
+        Get the error.
+
+        :param id: The error id.
+        :type id: str
+        :return: The error.
+        :rtype: Error
+        '''
+
+        # Not implemented.
+        raise NotImplementedError()
+    
+    # * method: list
+    def list(self) -> List[Error]:
+        '''
+        List all errors.
+
+        :return: The list of errors.
+        :rtype: List[Error]
+        '''
+
+        # Not implemented.
+        raise NotImplementedError()
+    
+    # * method: save
+    def save(self, error: Error):
+        '''
+        Save the error.
+
+        :param error: The error.
+        :type error: Error
+        '''
+
+        # Not implemented.
+        raise NotImplementedError
+
+
+# ** proxy: yaml_proxy
+class YamlProxy(ErrorRepository):
+    '''
+    The YAML proxy for the error repository
+    '''
+
+    # * field: config_file
+    config_file: str
+
+    # * method: init
+    def __init__(self, error_config_file: str):
+        '''
+        Initialize the yaml proxy.
+
+        :param error_config_file: The error configuration file.
+        :type error_config_file: str
+        '''
+
+        # Set the base path.
+        self.config_file = error_config_file
+
+    # * method: exists
+    def exists(self, id: str, **kwargs) -> bool:
+        '''
+        Check if the error exists.
+        
+        :param id: The error id.
+        :type id: str
+        :param kwargs: Additional keyword arguments.
+        :type kwargs: dict
+        :return: Whether the error exists.
+        :rtype: bool
+        '''
+
+        # Load the error data from the yaml configuration file.
+        data: List[ErrorData] = yaml_client.load(
+            self.config_file,
+            create_data=lambda data: ErrorData.from_yaml_data(
+                id=id, **data),
+            start_node=lambda data: data.get('errors').get(id))
+
+        # Return whether the error exists.
+        return data is not None
+
+    # * method: get
+    def get(self, id: str) -> Error:
+        '''
+        Get the error.
+        
+        :param id: The error id.
+        :type id: str
+        :return: The error.
+        :rtype: Error
+        '''
+
+        # Load the error data from the yaml configuration file.
+        _data: ErrorData = yaml_client.load(
+            self.config_file,
+            create_data=lambda data: ErrorData.from_yaml_data(
+                id=id, **data),
+            start_node=lambda data: data.get('errors').get(id))
+
+        # Return the error object.
+        return _data.map('to_object.yaml')
+    
+    # * method: list
+    def list(self) -> List[Error]:
+        '''
+        List all errors.
+
+        :return: The list of errors.
+        :rtype: List[Error]
+        '''
+
+        # Load the error data from the yaml configuration file.
+        _data: Dict[str, ErrorData] = yaml_client.load(
+            self.config_file,
+            create_data=lambda data: ErrorData.from_yaml_data(
+                id=id, **data),
+            start_node=lambda data: data.get('errors'))
+
+        # Return the error object.
+        return [data.map('to_object.yaml') for data in _data.values()]
+
+    # * method: save
+    def save(self, error: Error):
+        '''
+        Save the error.
+
+        :param error: The error.
+        :type error: Error
+        '''
+
+        # Create updated error data.
+        error_data = ErrorData.new(**error.to_primitive())
+
+        # Update the error data.
+        yaml_client.save(
+            path=self.config_file,
+            data=error_data,
+            data_save_path=f'errors/{error.name}',
+        )

app/repos/feature.py

@@ -0,0 +1,169 @@
+from typing import Dict, Any, List
+
+from ..data.feature import FeatureData
+from ..domain.feature import Feature
+
+from ..clients import yaml as yaml_client
+
+
+class FeatureRepository(object):
+    '''
+    Feature repository interface.
+    '''
+
+    def exists(self, id: str) -> bool:
+        '''
+        Verifies if the feature exists.
+
+        :param id: The feature id.
+        :type id: str
+        :return: Whether the feature exists.
+        :rtype: bool
+        '''
+
+        raise NotImplementedError()
+
+    def get(self, id: str) -> Feature:
+        '''
+        Get the feature by id.
+
+        :param id: The feature id.
+        :type id: str
+        :return: The feature object.
+        :rtype: f.Feature
+        '''
+
+        raise NotImplementedError()
+    
+    def list(self, group_id: str = None) -> List[Feature]:
+        '''
+        List the features.
+
+        :param group_id: The group id.
+        :type group_id: str
+        :return: The list of features.
+        :rtype: list
+        '''
+
+        raise NotImplementedError
+
+    def save(self, feature: Feature):
+        '''
+        Save the feature.
+        
+        :param feature: The feature object.
+        :type feature: f.Feature
+        '''
+
+        raise NotImplementedError()
+
+
+class YamlProxy(FeatureRepository):
+    '''
+    Yaml repository for features.
+    '''
+
+    def __init__(self, feature_yaml_base_path: str):
+        '''
+        Initialize the yaml repository.
+
+        :param feature_yaml_base_path: The base path to the yaml file.
+        :type feature_yaml_base_path: str
+        '''
+
+        # Set the base path.
+        self.base_path = feature_yaml_base_path
+
+    def exists(self, id: str) -> bool:
+        '''
+        Verifies if the feature exists.
+        
+        :param id: The feature id.
+        :type id: str
+        :return: Whether the feature exists.
+        :rtype: bool
+        '''
+
+        # Retrieve the feature by id.
+        feature = self.get(id)
+
+        # Return whether the feature exists.
+        return feature is not None
+
+    def get(self, id: str) -> Feature:
+        '''
+        Get the feature by id.
+        
+        :param id: The feature id.
+        :type id: str
+        :return: The feature object.
+        '''
+
+        # Get context group and feature key from the id.
+        group_id, feature_key = id.split('.')
+
+        # Load feature data from yaml.
+        _data: FeatureData = yaml_client.load(
+            self.base_path,
+            create_data=lambda data: FeatureData.from_yaml_data(
+                id=id,
+                group_id=group_id,
+                **data
+            ),
+            start_node=lambda data: data.get('features').get('groups').get(group_id).get('features').get(feature_key)
+        )
+
+        # Return None if feature data is not found.
+        if not _data:
+            return None
+
+        # Return feature.
+        return _data.map('to_object.yaml')
+    
+    def list(self, group_id: str = None) -> List[Feature]:
+        '''
+        List the features.
+        
+        :param group_id: The group id.
+        :type group_id: str
+        :return: The list of features.
+        :rtype: list
+        '''
+
+        # Load all feature data from yaml.
+        features = yaml_client.load(
+            self.base_path,
+            create_data=lambda data: [FeatureData.from_yaml_data(
+                id=id,
+                **feature_data
+            ) for id, feature_data in data.items()],
+            start_node=lambda data: data.get('features')
+        )
+
+        # Filter features by group id.
+        if group_id:
+            features = [feature for feature in features if feature.group_id == group_id]
+
+        # Return the list of features.
+        return [feature.map('to_object.yaml') for feature in features]
+
+    def save(self, feature: Feature):
+        '''
+        Save the feature.
+        
+        :param feature: The feature object.
+        :type feature: f.Feature
+        '''
+
+        # Create updated feature data.
+        feature_data = FeatureData.new(**feature.to_primitive())
+
+        # Update the feature data.
+        yaml_client.save(
+            self.base_path,
+            data=feature_data,
+            data_save_path=f'features/{feature.group_id}.{feature_data.feature_key}'
+        )
+
+        # Return the updated feature object.
+        return feature_data.map('to_object.yaml')

app/services/__init__.py

@@ -0,0 +1,4 @@
+from . import cli as cli_service
+from . import container as container_service
+from . import object as object_service
+from . import sync as sync_service

app/services/cli.py

@@ -0,0 +1,186 @@
+from typing import List, Dict, Any
+import argparse
+
+from ..contexts.request import RequestContext
+from ..domain.cli import CliInterface
+from ..domain.cli import CliArgument
+
+
+def create_argument_data(cli_argument: CliArgument):
+
+    # List fields to be excluded.
+    exclude_fields = ['name_or_flags', 'arg_type', 'to_data']
+
+    # Exclude unneeded fields if the argument contains an action.
+    if cli_argument.action:
+        exclude_fields.append('nargs')
+        exclude_fields.append('type')
+        exclude_fields.append('choices')
+
+    # Set the data type for the argument.
+    if cli_argument.type == 'str':
+        data_type = str
+    elif cli_argument.type == 'int':
+        data_type = int
+    elif cli_argument.type == 'float':
+        data_type = float
+
+    # For each name or flag in the argument,
+    for name in cli_argument.name_or_flags:
+
+        # If the name or flag is a positional argument,
+        if not name.startswith('--'):
+
+            # Remove the required field.
+            exclude_fields.append('required')
+
+    # Assemble the argument data.
+    argument_data = cli_argument.to_primitive()
+
+    # Set the data type.
+    argument_data['type'] = data_type
+
+    # For each field in the excluded fields,
+    for field in exclude_fields:
+
+        # Remove the field from the argument data if it is present.
+        try:
+            del argument_data[field]
+        except KeyError:
+            pass
+
+    # Return the argument data.
+    return argument_data
+
+
+def create_headers(data: dict):
+    headers = dict(
+        group_id=data.pop('group'),
+        command_id=data.pop('command'),
+    )
+    headers['id'] = f"{headers['group_id']}.{headers['command_id']}".replace(
+        '-', '_')
+    return headers
+
+
+def create_cli_parser(cli_interface: CliInterface):
+
+    # Format commands into a dictionary lookup by group id.
+    commands = {}
+    for command in cli_interface.commands:
+        group_id = command.group_id
+        if group_id not in commands:
+            commands[group_id] = []
+        commands[group_id].append(command)
+
+    # Create parser.
+    parser = argparse.ArgumentParser()
+
+    # Add command subparsers
+    command_subparsers = parser.add_subparsers(dest='group')
+    for group_id, commands in commands.items():
+        group_name = group_id.replace('_', '-')
+        command_subparser = command_subparsers.add_parser(
+            group_name)
+        subcommand_subparsers = command_subparser.add_subparsers(
+            dest='command')
+        for command in commands:
+            command_name = command.id.split('.')[-1].replace('_', '-')
+            subcommand_subparser = subcommand_subparsers.add_parser(
+                command_name)
+            for argument in command.arguments:
+                subcommand_subparser.add_argument(
+                    *argument.name_or_flags, **create_argument_data(argument))
+        for argument in cli_interface.parent_arguments:
+            subcommand_subparser.add_argument(
+                *argument.name_or_flags, **create_argument_data(argument))
+
+    return parser
+
+
+def create_request(request: argparse.Namespace, cli_interface: CliInterface, **kwargs) -> RequestContext:
+
+    # Convert argparse.Namespace to dictionary.
+    data = vars(request)
+
+    # Create header values.
+    headers = create_headers(data)
+
+    # Get the command from the CLI interface.
+    command = cli_interface.get_command(**headers)
+
+    # Create map of arguments to their data attribute names.
+    argument_map = {arg.get_name(): arg for arg in command.arguments}
+
+    # Map the data to the request context.
+    for key, value in data.items():
+        if value is None:
+            continue
+        argument = argument_map.get(key)
+        data[key] = map_object_input(value, argument)
+
+    # Create request context.
+    return RequestContext(
+        feature_id=command.feature_id,
+        data=data,
+        headers=headers,
+        **headers,
+        **kwargs
+    )
+
+
+def map_object_input(data: Any, argument: CliArgument):
+
+    # If the argument is not input to data,
+    if not argument.to_data:
+
+        # Return the data.
+        return data
+
+    # If the argument is a dictionary,
+    if argument.nargs:
+
+        # If the argument is a list, split the data by the delimiter.
+        result = {}
+
+        # For each item in the data, split the item into key and value.
+        for item in data:
+
+            # Split the item into key and value.
+            key, value = item.split('=')
+
+            # Add the key and value to the result.
+            result[key] = value
+
+        # Return result.
+        return result
+
+    # If the argument is an object list,
+    if argument.action == 'append':
+
+        # Create a list to store the result.
+        result = []
+
+        # For each row object in the data,
+        for row in data:
+
+            # Create an object to store the key value pairs.
+            obj = {}
+
+            # Split the row by the delimiter.
+            items = row.split(';')
+
+            # For each item in the row,
+            for item in items:
+
+                # Split the item into key and value.
+                key, value = item.split('=')
+
+                # Add the key and value to the object.
+                obj[key] = value
+
+            # Add the object to the result.
+            result.append(obj)
+
+        # Return result.
+        return result

app/services/container.py

@@ -0,0 +1,44 @@
+# *** imports
+
+# ** core
+from typing import Any
+
+# ** infra
+from dependencies import Injector
+
+
+# *** functions
+
+# ** function: import_dependency
+def import_dependency(module_path: str, class_name: str) -> Any:
+    '''
+    Import an object dependency from its configured Python module.
+
+    :param module_path: The module path.
+    :type module_path: str
+    :param class_name: The class name.
+    :type class_name: str
+    :return: The dependency.
+    :rtype: Any
+    '''
+
+    # Import module.
+    from importlib import import_module
+    return getattr(import_module(module_path), class_name)
+
+
+# ** function: create_injector
+def create_injector(name: str, **dependencies) -> Any:
+    '''
+    Create an injector object with the given dependencies.
+
+    :param name: The name of the injector.
+    :type name: str
+    :param dependencies: The dependencies.
+    :type dependencies: dict
+    :return: The injector object.
+    :rtype: Any
+    '''
+
+    # Create container.
+    return type(f'{name.capitalize()}Container', (Injector,), {**dependencies})

tiferet-1.0.0a0.dist-info/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Great Strength Systems LLC
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

tiferet-1.0.0a0.dist-info/METADATA

@@ -0,0 +1,13 @@
+Metadata-Version: 2.1
+Name: tiferet
+Version: 1.0.0a0
+Summary: A multi-purpose application framework embodying beauty in form.
+Home-page: https://github.com/greatstrength/app
+Download-URL: https://github.com/greatstrength/app
+Author: Andrew Shatz
+Author-email: andrew@greatstrength.me
+License: BSD 3
+License-File: LICENSE
+Requires-Dist: schematics >=2.1.1
+Requires-Dist: pyyaml >=6.0.1
+

tiferet-1.0.0a0.dist-info/RECORD

@@ -0,0 +1,41 @@
+app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+app/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+app/clients/yaml.py,sha256=-Eo8PX2oPpVxv1c-cpkNOrGhxx9T7XPYoAyGi1DxMi4,2454
+app/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+app/commands/container.py,sha256=L2IKJqEbRglw_LC144oYAkARr2Rixj8IFuC6Ro1jAqA,1789
+app/commands/error.py,sha256=ixMYH0yrEWlMAVGDSRke3IGoWaOShfmiXntrUC2b3wY,573
+app/commands/feature.py,sha256=tXa-MDf14ByIJqwQFeSUu2QLUjHPdsyvFNhj1XeaQVk,2507
+app/configs/__init__.py,sha256=NfT6XFNcJznOLXjMuNmj3XeaOPVWwbc-N4kVWaVjuD0,845
+app/configs/app.py,sha256=YWKVPTCaCVwpmTbdUdeZya-IfJvxxenGQpcUD7YbU54,302
+app/configs/container.py,sha256=x9JwWi7XRRnoVahf858REYNY3ZxCaznjGJUqoAK1FZs,2106
+app/contexts/__init__.py,sha256=0HzyDBIyyF8fZ0gOXekzfzHWVkbLFUx9eLLzuooEzFs,63
+app/contexts/app.py,sha256=MPRFu3ut7DOmc3i3PqLR96ymvWMShW6BUbY9eG8i6Eg,3296
+app/contexts/container.py,sha256=RI33tK9XF18PaUfOp64ddMZGOCMIy3XNgQMUtJ_jYNE,4924
+app/contexts/env.py,sha256=bbvZzDy075SuKL2ZIfDEE5yD1Hbk-4XLGe4eC_tT8e8,3080
+app/contexts/error.py,sha256=VO3Wgkmf5bdK6LoT0xhQn1WeSAVulQwUhvBAsoUPd1c,2503
+app/contexts/feature.py,sha256=u7wEhdfTLeWKIv5i2nzBcu4cAcVkm6iqNNznczPmHjc,2293
+app/contexts/request.py,sha256=TOECa0V1wKuNGCYFIRKxwsZVpLtP0FS_Nm96DaEVsWU,2726
+app/data/__init__.py,sha256=ts3bkFftArKTgUJj7q65Sob4fC6jOqfYNxm6cqjFr_w,74
+app/data/app.py,sha256=8kv7tDJUjl70bqdpiMXXs6e89zDQIvtlDSOq42iyyX0,6312
+app/data/container.py,sha256=jTQlT4D-lLC_QLNAmMara6O78g667GXk1LU_EyuX_HU,5180
+app/data/error.py,sha256=lfGO3SjtsxSv6d7iKDeVw3vXfocCk29g4-uwC3jnaig,2377
+app/data/feature.py,sha256=s_aqVYhH7VKzXpWM3d-uvSv3_r8A0LgObv3Agg-CKoc,3697
+app/domain/__init__.py,sha256=uC1lHXzRnpoHqfgPcUraea5F_T1Nsx0wBau0paslsQg,146
+app/domain/app.py,sha256=t_TcemJfpSa_CQfjcSfRRo2iFS1ilanfpHTiHx1vM8w,8528
+app/domain/container.py,sha256=Kw_xNn5_tWghcx3Dl_vPEdwZ2b8u23ZpbgMQ_bkUKaw,3666
+app/domain/core.py,sha256=a1nJvH7bCqP_JvGrkMDClH8nef2L3WHpmTV6ksmdZ4c,4600
+app/domain/error.py,sha256=myUpdB4rgmbVBwIP8Pa88uastTSjPFGqrSwqR9C-VYg,3371
+app/domain/feature.py,sha256=RhedOKb8nG1D0J9b_aPVtJc_rQjLXwOpwpIsmzrH21o,4552
+app/repos/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+app/repos/app.py,sha256=VptevFxeST5slbk_em7dazXgz5U8f_XLDsGdM0Gq3qE,2696
+app/repos/container.py,sha256=2Medggn4BZrelnZ-cDZfFFwHaDB80R7iFJ5OF-6E62g,4811
+app/repos/error.py,sha256=c3Bs2QTktMuJWGSRF8rKeTN5vFEsaOycUdYD7QSIDEc,4224
+app/repos/feature.py,sha256=uR4s-n28J4WCO4Npi6AzOxk5R9I6HuUMHDzoK1Xo_80,4361
+app/services/__init__.py,sha256=CIyUCm2oFrhZvCLPCPz3UG-eghdkIBgqayxoOr-QrdE,151
+app/services/cli.py,sha256=aqrn7kxqe2xTJWBSs5hDiyD0ND50mPVDIJf_C87YgRk,5364
+app/services/container.py,sha256=yZU09pziCMz74UIRqiM_gHNqNE4Hml555WEuNoJlEDA,1048
+tiferet-1.0.0a0.dist-info/LICENSE,sha256=e8_GutFM0sxbRlgUaeVsGvJ5uE-KvruLApOzIoHy_zU,1513
+tiferet-1.0.0a0.dist-info/METADATA,sha256=kxGZQgEojSufeAWAvLtuL0RV4-Z58KIBcI9hUkbQ5kE,386
+tiferet-1.0.0a0.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+tiferet-1.0.0a0.dist-info/top_level.txt,sha256=io9g7LCbfmTG1SFKgEOGXmCFB9uMP2H5lerm0HiHWQE,4
+tiferet-1.0.0a0.dist-info/RECORD,,

tiferet-1.0.0a0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.5.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

tiferet-1.0.0a0.dist-info/top_level.txt

@@ -0,0 +1 @@
+app