labfreed 0.1.0__py2.py3-none-any.whl → 0.1.1__py2.py3-none-any.whl

labfreed/IO/parse_pac.py

@@ -25,6 +25,7 @@ class PACID_With_Extensions(BaseModelWithValidationMessages):
     def __str__(self):
         out = str(self.pac_id)
         out += '*'.join(str(e) for e in self.extensions)
+        return out
         
     def get_extension_of_type(self, type:str) -> list[Extension]:
         return [e for e in self.extensions if e.type == type]
@@ -87,7 +88,7 @@ class PAC_Parser():
     def __init__(self, extension_interpreters:dict[str, Extension]=None):
         self.extension_interpreters = extension_interpreters or {'TREX': TREX, 'N': DisplayNames}
         
-    def parse(self, pac_url:str) -> PACID_With_Extensions:
+    def parse(self, pac_url:str, suppress_errors=False) -> PACID_With_Extensions:
         if '*' in pac_url:
             id_str, ext_str = pac_url.split('*', 1)
         else:
@@ -98,8 +99,8 @@ class PAC_Parser():
         extensions = self._parse_extensions(ext_str)
         
         pac_with_extension = PACID_With_Extensions(pac_id=pac_id, extensions=extensions)
-        if not pac_with_extension.is_valid():
-            raise LabFREEDValidationError(validation_msgs = pac_with_extension.get_nested_validation_messages())
+        if not pac_with_extension.is_valid() and not suppress_errors:
+            raise LabFREEDValidationError(validation_msgs = pac_with_extension.get_nested_validation_messages(), model=pac_with_extension)
         
         return pac_with_extension
             

labfreed/PAC_CAT/data_model.py

@@ -4,7 +4,11 @@ from abc import ABC
 from typing import Self
 from pydantic import Field, computed_field, model_validator
 
-from labfreed.validation import BaseModelWithValidationMessages
+from rich import print
+from rich.text import Text
+from rich.table import Table
+
+from labfreed.validation import BaseModelWithValidationMessages, ValidationMsgLevel
 
 from ..PAC_ID.data_model import PACID, IDSegment
 
@@ -132,24 +136,37 @@ class PAC_CAT(PACID):
                 for k in duplicate_keys:
                     self.add_validation_message(
                         source=f"identifier {k}",
-                        type="Error",
+                        level = ValidationMsgLevel.ERROR,
                         msg=f"Duplicate key {k} in category {c.key}",
                         highlight_pattern = k
                     )
             return self
         
     def print_categories(self):
+        
+        table = Table(title=f'Categories in {str(self)}', show_header=False)
+        table.add_column('0')
+        table.add_column('1')
         s = ''
         for i, c in enumerate(self.categories):
             if i == 0:
-                title = 'Main Category\n----------'
+                title = Text('Main Category', style='bold')
             else:
-                title = 'Category\n------ '
+                title = Text('Category', style='bold')
+            
+            table.add_row(title)
             
-            s += f'{title}\n'
-            s += str(c)
-            s += '\n'
-        print(s)
+            for field_name, field_info in c.model_fields.items():
+                if not getattr(c, field_name):
+                    continue
+                table.add_row(f"{field_name} ({field_info.alias or ''})",
+                              f" {getattr(c, field_name)}"
+                              )      
+            table.add_section()        
+        print(table)
+        
+ 
+
         
         
     # @classmethod
@@ -202,18 +219,21 @@ class Category(BaseModelWithValidationMessages):
     @model_validator(mode='after')
     def warn_unusual_category_key(self):
         ''' this base class is instantiated only if the key is not a known category key'''
-        self.add_validation_message(
-                    source=f"Category {self.key}",
-                    type="Warning",
-                    msg=f'Category key {self.key} is not a well known key. It is recommended to use well known keys only',
-                    highlight_pattern = f"{self.key}"
-        )
+        if type(self) is Category:
+            self.add_validation_message(
+                        source=f"Category {self.key}",
+                        level = ValidationMsgLevel.RECOMMENDATION,
+                        msg=f'Category key {self.key} is not a well known key. It is recommended to use well known keys only',
+                        highlight_pattern = f"{self.key}"
+            )
         return self
     
     
     def __str__(self):
         s = '\n'.join( [f'{field_name} \t ({field_info.alias or ''}): \t {getattr(self, field_name)}' for  field_name, field_info in self.model_fields.items() if getattr(self, field_name)]) 
         return s
+ 
+
     
     
     # def to_identifier_category(self, use_short_notation=False):
@@ -278,14 +298,14 @@ class Material_Device(Category):
         if not self.model_number:
             self.add_validation_message(
                     source=f"Category {self.key}",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     msg=f'Category key {self.key} is missing mandatory field Model Number',
                     highlight_pattern = f"{self.key}"
             )
         if not self.serial_number:
             self.add_validation_message(
                     source=f"Category {self.key}",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     msg=f'Category key {self.key} is missing mandatory field Serial Number',
                     highlight_pattern = f"{self.key}"
             )
@@ -303,7 +323,7 @@ class Material_Substance(Category):
         if not self.product_number:
             self.add_validation_message(
                     source=f"Category {self.key}",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     msg=f'Category key {self.key} is missing mandatory field Product Number',
                     highlight_pattern = f"{self.key}"
             )
@@ -321,7 +341,7 @@ class Material_Consumable(Category):
         if not self.product_number:
             self.add_validation_message(
                     source=f"Category {self.key}",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     msg=f"Category key {self.key} is missing mandatory field 'Product Number'",
                     highlight_pattern = f"{self.key}"
             )
@@ -341,7 +361,7 @@ class Data_Abstract(Category, ABC):
         if not self.id:
             self.add_validation_message(
                     source=f"Category {self.key}",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     msg=f"Category key {self.key} is missing mandatory field 'ID'",
                     highlight_pattern = f"{self.key}"
             )

labfreed/PAC_ID/data_model.py

@@ -6,7 +6,7 @@ from pydantic import Field, ValidationInfo, computed_field, conlist, model_valid
 from abc import ABC, abstractproperty, abstractstaticmethod
 
 from ..utilities.well_known_keys import WellKnownKeys
-from labfreed.validation import BaseModelWithValidationMessages, ValidationMessage, hsegment_pattern, domain_name_pattern
+from labfreed.validation import BaseModelWithValidationMessages, ValidationMessage, ValidationMsgLevel, hsegment_pattern, domain_name_pattern
 
 
 class IDSegment(BaseModelWithValidationMessages):
@@ -23,9 +23,8 @@ class IDSegment(BaseModelWithValidationMessages):
         if not_allowed_chars := set(re.sub(hsegment_pattern, '', key)):
             self.add_validation_message(
                     source=f"id segment key {key}",
-                    type="Error",
-                    msg=f"{' '.join(not_allowed_chars)} must not be used.",
-                    recommendation = "The segment key must be a valid hsegment",
+                    level = ValidationMsgLevel.ERROR,
+                    msg=f"{' '.join(not_allowed_chars)} must not be used. The segment key must be a valid hsegment",
                     highlight_pattern = key,
                     highlight_sub = not_allowed_chars
             )
@@ -33,9 +32,8 @@ class IDSegment(BaseModelWithValidationMessages):
         if not_allowed_chars := set(re.sub(hsegment_pattern, '', value)):
             self.add_validation_message(
                     source=f"id segment key {value}",
-                    type="Error",
-                    msg=f"{' '.join(not_allowed_chars)} must not be used.",
-                    recommendation = "The segment key must be a valid hsegment",
+                    level = ValidationMsgLevel.ERROR,
+                    msg=f"{' '.join(not_allowed_chars)} must not be used. The segment key must be a valid hsegment",
                     highlight_pattern = value,
                     highlight_sub = not_allowed_chars
             )
@@ -44,9 +42,8 @@ class IDSegment(BaseModelWithValidationMessages):
         if not_recommended_chars := set(re.sub(r'[A-Z0-9-:+]', '', key)):
             self.add_validation_message(
                     source=f"id segment key {key}",
-                    type="Recommendation",
-                    msg=f"{' '.join(not_recommended_chars)} should not be used.",
-                    recommendation = "SHOULD be limited to A-Z, 0-9, and -+",
+                    level = ValidationMsgLevel.RECOMMENDATION,
+                    msg=f"{' '.join(not_recommended_chars)} should not be used. Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+' ",
                     highlight_pattern = key,
                     highlight_sub = not_recommended_chars
                 )
@@ -55,10 +52,10 @@ class IDSegment(BaseModelWithValidationMessages):
         if key and key not in [k.value for k in WellKnownKeys]:
             self.add_validation_message(
                     source=f"id segment key {key}",
-                    type="Recommendation",
-                    msg=f"{key} is not a well known segment key.",
-                    recommendation = "RECOMMENDED to be a well-known id segment key.",
-                    highlight_pattern = key
+                    level = ValidationMsgLevel.RECOMMENDATION,
+                    msg=f"{key} is not a well known segment key. It is RECOMMENDED to use well-known keys.",
+                    highlight_pattern = key,
+                    highlight_sub=[key]
                 )
             
             
@@ -66,9 +63,8 @@ class IDSegment(BaseModelWithValidationMessages):
         if not_recommended_chars := set(re.sub(r'[A-Z0-9-:+]', '', value)):
             self.add_validation_message(
                     source=f"id segment value {value}",
-                    type="Recommendation",
-                    msg=f"Characters {' '.join(not_recommended_chars)} should not be used.",
-                    recommendation = "SHOULD be limited to A-Z, 0-9, and -+",
+                    level = ValidationMsgLevel.RECOMMENDATION,
+                    msg=f"Characters {' '.join(not_recommended_chars)} should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+' ",
                     highlight_pattern = value,
                     highlight_sub = not_recommended_chars
                 )
@@ -78,14 +74,14 @@ class IDSegment(BaseModelWithValidationMessages):
         if ':' in key:
             self.add_validation_message(
                     source=f"id segment key {key}",
-                    type="Recommendation",
+                    level = ValidationMsgLevel.RECOMMENDATION,
                     msg=f"Character ':' should not be used in segment key, since this character is used to separate key and value this can lead to undefined behaviour.",
                     highlight_pattern = key
                 )
         if ':' in value:
             self.add_validation_message(
                     source=f"id segment value {value}",
-                    type="Recommendation",
+                    level = ValidationMsgLevel.RECOMMENDATION,
                     msg=f"Character ':' should not be used in segment value, since this character is used to separate key and value this can lead to undefined behaviour.",
                     highlight_pattern = value
                 )
@@ -113,9 +109,8 @@ class PACID(BaseModelWithValidationMessages):
         if l > 256:
             self.add_validation_message(
                         source=f"identifier",
-                        type="Error",
-                        msg=f'Identifier is {l} characters long, Identifier must not exceed 256 characters.',
-                        highlight_pattern = ""
+                        level = ValidationMsgLevel.ERROR,
+                        msg=f'Identifier is {l} characters long, Identifier must not exceed 256 characters.'
                     )
         return self
        
@@ -125,7 +120,7 @@ class PACID(BaseModelWithValidationMessages):
         if not re.fullmatch(domain_name_pattern, self.issuer):
             self.add_validation_message(
                     source="PAC-ID",
-                    type="Error",
+                    level = ValidationMsgLevel.ERROR,
                     highlight_pattern=self.issuer,
                     msg=f"Issuer must be a valid domain name. "
                 )
@@ -134,7 +129,7 @@ class PACID(BaseModelWithValidationMessages):
         if not_recommended_chars := set(re.sub(r'[A-Z0-9\.-]', '', self.issuer)):
             self.add_validation_message(
                     source="PAC-ID",
-                    type="Recommendation",
+                    level = ValidationMsgLevel.RECOMMENDATION,
                     highlight_pattern=self.issuer,
                     highlight_sub=not_recommended_chars,
                     msg=f"Characters {' '.join(not_recommended_chars)} should not be used. Issuer SHOULD contain only the characters A-Z, 0-9, -, and . "
@@ -150,7 +145,7 @@ class PACID(BaseModelWithValidationMessages):
             for k in duplicate_keys:
                 self.add_validation_message(
                     source=f"identifier {k}",
-                    type="Recommendation",
+                    level = ValidationMsgLevel.RECOMMENDATION,
                     msg=f"Duplicate segment key {k}. This will probably lead to undefined behaviour",
                     highlight_pattern = k
                 )

labfreed/PAC_ID_Resolver/cit.yaml

@@ -26,7 +26,7 @@ macros:
       service_type: userhandover-generic
       application_intents:
         - dummy
-      template_url: https://mettorius.com/om/an={$..*['240'].value}
+      template_url: https://mettorius.com/
 
 
 cit:

labfreed/PAC_ID_Resolver/data_types.py

@@ -1,4 +1,7 @@
+from concurrent.futures import ThreadPoolExecutor, as_completed
+from enum import Enum, auto
 from pydantic import BaseModel, Field, field_validator
+from requests import RequestException, request, ConnectionError, ReadTimeout
 from rich import print
 from rich.table import Table
 
@@ -29,18 +32,40 @@ class CIT(BaseModelWithValidationMessages):
     
     
 
+class ServiceState(Enum):
+    ACTIVE = auto()
+    INACTIVE = auto()
+    UNKNOWN = auto()
     
 class Service(BaseModelWithValidationMessages):
     service_name: str
     application_intents:list[str]
     service_type:str
     url:str
+    active:ServiceState =ServiceState.UNKNOWN
     
+    def check_state(self):
+        try:
+            r = request('get',self.url, timeout=2)
+            if r.status_code < 400:
+                self.active = ServiceState.ACTIVE
+            else: 
+                self.active = ServiceState.INACTIVE
+        except RequestException as e:
+            print(f"Request failed: {e}")
+            self.active = ServiceState.INACTIVE
+            
     
 class CITEvaluated(BaseModelWithValidationMessages):
     origin: str = ""
     services: list[Service] = Field(default_factory=list)
     
+    def update_states(self):
+        with ThreadPoolExecutor(max_workers=10) as executor:
+            futures = [executor.submit(s.check_state) for s in self.services]
+            for _ in as_completed(futures):
+                pass  # just wait for all to finish
+    
     def __str__(self):
         out = [f'CIT (origin {self.origin})']
         for s in self.services:
@@ -52,8 +77,9 @@ class CITEvaluated(BaseModelWithValidationMessages):
 
         table.add_column("Service Name")
         table.add_column("URL")
+        table.add_column('Reachable')
         
         for s in self.services:
-            table.add_row(s.service_name, s.url)
+            table.add_row(s.service_name, s.url, s.active.name)
 
         print(table)

labfreed/TREX/data_model.py

@@ -8,7 +8,7 @@ from typing import Annotated, Literal
 from pydantic import PrivateAttr, RootModel, ValidationError, field_validator, model_validator, Field
 from labfreed.TREX.unece_units import unece_unit, unece_unit_codes, unece_units, unit_name, unit_symbol
 from labfreed.utilities.utility_types import DataTable, Quantity, Unit, unece_unit_code_from_quantity
-from labfreed.validation import BaseModelWithValidationMessages
+from labfreed.validation import BaseModelWithValidationMessages, ValidationMsgLevel
 from abc import ABC,  abstractmethod
 
 from labfreed.PAC_ID.extensions import Extension
@@ -180,7 +180,7 @@ class BoolValue(ValueMixin):
         if not self.value in ['T', 'F']:
             self.add_validation_message(
                 source=f"TREX boolean value {self.value}",
-                type="Error",
+                level= ValidationMsgLevel.ERROR,
                 msg=f'{self.value} is no valid boolean. Must be T or F',
                 highlight_pattern = f'{self.value}',
                 highlight_sub=[c for c in self.value]
@@ -207,7 +207,7 @@ class AlphanumericValue(ValueMixin):
         if re.match(r'[a-z]', self.value):
             self.add_validation_message(
                     source=f"TREX value {self.value}",
-                    type="Error",
+                    level= ValidationMsgLevel.ERROR,
                     msg=f"Lower case characters are not allowed.",
                     highlight_pattern = self.value
             )
@@ -215,7 +215,7 @@ class AlphanumericValue(ValueMixin):
         if not_allowed_chars := set(re.sub(r'[A-Z0-9\.-]', '', self.value)):
             self.add_validation_message(
                     source=f"TREX value {self.value}",
-                    type="Error",
+                    level= ValidationMsgLevel.ERROR,
                     msg=f"Characters {','.join(not_allowed_chars)} are not allowed in alphanumeric segment",
                     highlight_pattern = self.value,
                     highlight_sub=not_allowed_chars
@@ -242,7 +242,7 @@ class TextValue(ValueMixin):
         if not_allowed_chars := set(re.sub(r'[A-Z0-9]', '', self.value)):
             self.add_validation_message(
                     source=f"TREX value {self.value}",
-                    type="Error",
+                    level= ValidationMsgLevel.ERROR,
                     msg=f"Characters {','.join(not_allowed_chars)} are not allowed in text segment. Base36 encoding only allows A-Z0-9",
                     highlight_pattern = self.value,
                     highlight_sub=not_allowed_chars
@@ -268,7 +268,7 @@ class BinaryValue(ValueMixin):
         if not_allowed_chars := set(re.sub(r'[A-Z0-9]', '', self.value)):
            self.add_validation_message(
                     source=f"TREX value {self.value}",
-                    type="Error",
+                    tlevel= ValidationMsgLevel.ERROR,
                     msg=f"Characters {','.join(not_allowed_chars)} are not allowed in text segment. Base36 encoding only allows A-Z0-9",
                     highlight_pattern = self.value,
                     highlight_sub=not_allowed_chars
@@ -286,7 +286,7 @@ class ErrorValue(ValueMixin):
         if not_allowed_chars := set(re.sub(r'[A-Z0-9\.-]', '', self.value)):
             self.add_validation_message(
                     source=f"TREX value {self.value}",
-                    type="Error",
+                    level= ValidationMsgLevel.ERROR,
                     msg=f"Characters {','.join(not_allowed_chars)} are not allowed in error segment",
                     highlight_pattern = self.value,
                     highlight_sub=not_allowed_chars
@@ -309,7 +309,7 @@ class ValueSegment(TREX_Segment, ValueMixin, ABC):
         if not self.type in valid_types:
             self.add_validation_message(
                     source=f"TREX value segment {self.key}",
-                    type="Error",
+                    level= ValidationMsgLevel.ERROR,
                     msg=f"Type {self.type} is invalid. Must be 'T.D', 'T.B', 'T.A', 'T.T', 'T.X', 'E' or a UNECE unit",
                     highlight_pattern = self.type
             )
@@ -385,7 +385,7 @@ class ColumnHeader(BaseModelWithValidationMessages):
         if not_allowed_chars := set(re.sub(r'[A-Z0-9\.-]', '', self.key)):
             self.add_validation_message(
                 source=f"TREX table column {self.key}",
-                type="Error",
+                level= ValidationMsgLevel.ERROR,
                 msg=f"Column header key contains invalid characters: {','.join(not_allowed_chars)}",
                 highlight_pattern = f'{self.key}$',
                 highlight_sub=not_allowed_chars
@@ -398,7 +398,7 @@ class ColumnHeader(BaseModelWithValidationMessages):
         if not self.type in valid_types:
             self.add_validation_message(
                     source=f"TREX table column {self.key}",
-                    type="Error",
+                    level= ValidationMsgLevel.ERROR,
                     msg=f"Type '{self.type}' is invalid. Must be 'T.D', 'T.B', 'T.A', 'T.T', 'T.X', 'E' or a UNECE unit",
                     highlight_pattern = self.type
             )
@@ -435,7 +435,7 @@ class TREX_Table(TREX_Segment):
         if len(self.column_headers) != most_common_len:
             self.add_validation_message(
                     source=f"Table {self.key}",
-                    type="Error",
+                    level= ValidationMsgLevel.ERROR,
                     msg=f"Size mismatch: Table header contains {self.column_names} keys, while most rows have {most_common_len}",
                     highlight_pattern = self.key
             )
@@ -448,7 +448,7 @@ class TREX_Table(TREX_Segment):
             if len(row) != expected_row_len:
                 self.add_validation_message(
                     source=f"Table {self.key}",
-                    type="Error",
+                    level= ValidationMsgLevel.ERROR,
                     msg=f"Size mismatch: Table row {i} contains {len(row)} elements. Expected size is {expected_row_len}",
                     highlight_pattern = row.serialize_for_trex()
                 )
@@ -480,7 +480,7 @@ class TREX_Table(TREX_Segment):
                 except AssertionError:
                     self.add_validation_message(
                         source=f"Table {self.key}",
-                        type="Error",
+                        level= ValidationMsgLevel.ERROR,
                         msg=f"Type mismatch: Table row {i}, column {nm} is of wrong type. According to the header it should be {t_expected}",
                         highlight_pattern = row.serialize_for_trex(),
                         highlight_sub=[c for c in e.value]
@@ -490,7 +490,7 @@ class TREX_Table(TREX_Segment):
                     for m in msg:
                         self.add_validation_message(
                             source=f"Table {self.key}",
-                            type="Error",
+                            level= ValidationMsgLevel.ERROR,
                             msg=m.problem_msg,
                             highlight_pattern = row.serialize_for_trex(),
                             highlight_sub=[c for c in e.value]

labfreed/__init__.py

@@ -2,4 +2,4 @@
 Python implementation of LabFREED building blocks
 '''
 
-__version__ = "0.1.0"
+__version__ = "0.1.1"

labfreed/validation.py

@@ -1,37 +1,52 @@
+from enum import Enum, auto
+import re
 from pydantic import BaseModel, Field, PrivateAttr
 from typing import List, Set, Tuple
 
 from rich import print
 from rich.text import Text
+from rich.table import Table
 
 
 domain_name_pattern = r"(?!-)([A-Za-z0-9-]{1,63}(?<!-)\.)+[A-Za-z]{2,63}"
 hsegment_pattern = r"[A-Za-z0-9_\-\.~!$&'()+,:;=@]|%[0-9A-Fa-f]{2}"
 
 
+class ValidationMsgLevel(Enum):
+    ERROR = auto()
+    ERROR_AUTO_FIX = auto()
+    WARNING = auto()
+    RECOMMENDATION = auto()
+    INFO = auto()
+
 class ValidationMessage(BaseModel):
+    source_id:int
     source:str 
-    type: str
+    level: ValidationMsgLevel
     problem_msg:str
     recommendation_msg: str = ""
     highlight:str = "" #this can be used to highlight problematic parts
-    highlight_sub:list[str] = Field(default_factory=list)
+    highlight_sub_patterns:list[str] = Field(default_factory=list)
+
+
+    
         
-    @property
-    def emphazised_highlight(self):
-        fmt = lambda s: f'[emph]{s}[/emph]'
         
-        if not self.highlight_sub:
-            return fmt(self.highlight)
+    # @property
+    # def emphazised_highlight(self):
+    #     fmt = lambda s: f'[emph]{s}[/emph]'
+        
+    #     if not self.highlight_sub_patterns:
+    #         return fmt(self.highlight)
           
-        result = []
-        for c in self.highlight:
-            if c in self.highlight_sub:
-                result.append(fmt(c))
-            else:
-                result.append(c)
+    #     result = []
+    #     for c in self.highlight:
+    #         if c in self.highlight_sub_patterns:
+    #             result.append(fmt(c))
+    #         else:
+    #             result.append(c)
 
-        return ''.join(result)
+    #     return ''.join(result)
 
     
 class LabFREEDValidationError(ValueError):
@@ -51,10 +66,10 @@ class BaseModelWithValidationMessages(BaseModel):
     The purpose of that is to allow only minimal validation but on top check for stricter recommendations"""
     _validation_messages: list[ValidationMessage] = PrivateAttr(default_factory=list)
 
-    def add_validation_message(self, *, msg: str, type:str, recommendation:str="", source:str="", highlight_pattern="", highlight_sub=None):
+    def add_validation_message(self, *, msg: str, level:ValidationMsgLevel, recommendation:str="", source:str="", highlight_pattern="", highlight_sub=None):
         if not highlight_sub:
             highlight_sub = []
-        w = ValidationMessage(problem_msg=msg, recommendation_msg=recommendation, source=source, type=type, highlight=highlight_pattern, highlight_sub=highlight_sub)
+        w = ValidationMessage(problem_msg=msg, recommendation_msg=recommendation, source=source, level=level, highlight=highlight_pattern, highlight_sub_patterns=highlight_sub, source_id=id(self))
 
         if not w in self._validation_messages:
             self._validation_messages.append(w)
@@ -113,47 +128,116 @@ class BaseModelWithValidationMessages(BaseModel):
         return filter_warnings(self.get_nested_validation_messages())
     
     
-    def print_validation_messages(self, str_to_highlight_in=None, target='console'):
-        if not str_to_highlight_in:
-            str_to_highlight_in = str(self)
+    def str_for_validation_msg(self, validation_msg:ValidationMessage):
+        if validation_msg.source_id == id(self):
+            return validation_msg.source_id
+            #return validation_msg.emphasize_in(self(str))
+        else:
+            return str(self)
+        
+    def str_highlighted(self):
+        raise NotImplementedError("Subclasses must implement format_special()")
+    
+    
+        
+    def _emphasize_in(self, validation_msg, validation_node_str:str, fmt, color='black'):
+        if validation_msg.highlight_sub_patterns:
+            replacements = validation_msg.highlight_sub_patterns
+        else:
+            replacements = [validation_msg.highlight]
+        # Sort patterns by length descending to avoid subpattern clobbering
+        sorted_patterns = sorted(replacements, key=len, reverse=True)
+        # Escape the patterns for regex safety
+        escaped_patterns = [re.escape(p) for p in sorted_patterns]
+        # Create one regex pattern with alternation (longest first)
+        pattern = re.compile("|".join(escaped_patterns))
+        
+        out = pattern.sub(lambda m: fmt(m.group(0)), validation_node_str)
+        return out
+    
+    
+    def print_validation_messages(self, target='console'):
         msgs = self.get_nested_validation_messages()
-        print('\n'.join(['\n',
-                         '=======================================',
-                         'Validation Results',
-                         '---------------------------------------'
-                        ]
-                        )
-        )
         
+        table = Table(title=f"Validation Results", show_header=False)
+
+        col = lambda s:  table.add_column(s, vertical='top')
+        col("-")
+        
+             
         if not msgs:
-            print('All clear!')
+            table.add_row('All clear!', end_section=True)
             return
 
         for m in msgs:
-            if m.type.casefold() == "error":
+            if m.level == ValidationMsgLevel.ERROR:
                 color = 'red'
             else:
                 color = 'yellow'
                 
-            text = Text.from_markup(f'\n [bold {color}]{m.type} [/bold {color}] in \t {m.source}' )
-            print(text)
             match target:
                 case 'markdown':
-                    formatted_highlight = m.emphazised_highlight.replace('emph', f'🔸').replace('[/', '').replace('[', '').replace(']', '')
+                    fmt = lambda s: f'🔸{s}🔸'
                 case 'console':     
-                    formatted_highlight = m.emphazised_highlight.replace('emph', f'bold {color}')
+                    fmt = lambda s: f'[{color} bold]{s}[/{color} bold]'
                 case 'html':
-                    formatted_highlight = m.emphazised_highlight.replace('emph', f'b').replace('[', '<').replace(']', '>')
-            fmtd = str_to_highlight_in.replace(m.highlight, formatted_highlight)
-            fmtd = Text.from_markup(fmtd)
-            print(fmtd)
-            print(Text.from_markup(f'{m.problem_msg}'))
+                    fmt = lambda s: f'<span class="val_{color}">{s}</span>'
+                case 'html_styled':
+                    fmt = lambda s: f'<b style="color:{color}>{s}</b>'
+                
+            serialized = str(self)
+            emphazised_highlight = self._emphasize_in(m, serialized, fmt=fmt, color=color)
+            
+            txt =       f'[bold {color}]{m.level.name} [/bold {color}]'
+            txt += '\n' + f'{m.problem_msg}'
+            txt += '\n' + emphazised_highlight
+
+            table.add_row( txt)
+            table.add_section()
+
+        print(table)
+    
+    # def print_validation_messages_(self, str_to_highlight_in=None, target='console'):
+    #     if not str_to_highlight_in:
+    #         str_to_highlight_in = str(self)
+    #     msgs = self.get_nested_validation_messages()
+    #     print('\n'.join(['\n',
+    #                      '=======================================',
+    #                      'Validation Results',
+    #                      '---------------------------------------'
+    #                     ]
+    #                     )
+    #     )
+        
+    #     if not msgs:
+    #         print('All clear!')
+    #         return
+
+    #     for m in msgs:
+    #         if m.level.casefold() == "error":
+    #             color = 'red'
+    #         else:
+    #             color = 'yellow'
+                
+    #         text = Text.from_markup(f'\n [bold {color}]{m.level} [/bold {color}] in \t {m.source}' )
+    #         print(text)
+    #         match target:
+    #             case 'markdown':
+    #                 formatted_highlight = m.emphazised_highlight.replace('emph', f'🔸').replace('[/', '').replace('[', '').replace(']', '')
+    #             case 'console':     
+    #                 formatted_highlight = m.emphazised_highlight.replace('emph', f'bold {color}')
+    #             case 'html':
+    #                 formatted_highlight = m.emphazised_highlight.replace('emph', f'b').replace('[', '<').replace(']', '>')
+    #         fmtd = str_to_highlight_in.replace(m.highlight, formatted_highlight)
+    #         fmtd = Text.from_markup(fmtd)
+    #         print(fmtd)
+    #         print(Text.from_markup(f'{m.problem_msg}'))
         
     
     
 def filter_errors(val_msg:list[ValidationMessage]) -> list[ValidationMessage]:
-    return [ m for m in val_msg if m.type.casefold() == "error" ]
+    return [ m for m in val_msg if m.level == ValidationMsgLevel.ERROR ]
 
 def filter_warnings(val_msg:list[ValidationMessage]) -> list[ValidationMessage]:
-    return [ m for m in val_msg if m.type.casefold() != "error" ]     
+    return [ m for m in val_msg if m.level != ValidationMsgLevel.ERROR  ]     
 

labfreed-0.1.1.dist-info/METADATA

@@ -0,0 +1,279 @@
+Metadata-Version: 2.4
+Name: labfreed
+Version: 0.1.1
+Summary: Python implementation of LabFREED building blocks
+Author-email: Reto Thürer <thuerer.r@buchi.com>
+Description-Content-Type: text/markdown
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: numpy>=2.2.4
+Requires-Dist: pydantic>=2.11.3
+Requires-Dist: segno>=1.6.6
+Requires-Dist: typer>=0.15.2
+
+# LabFREED for Python
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![PyPI](https://img.shields.io/pypi/v/labfreed.svg)](https://pypi.org/project/labfreed/) ![Python Version](https://img.shields.io/pypi/pyversions/labfreed)
+
+<!--
+[![Tests](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml/badge.svg)](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml)
+-->
+
+This is a Python implementation of [LabFREED](https://labfreed.wega-it.com) building blocks.
+
+## Supported Building Blocks
+- PAC-ID
+- PAC-CAT
+- TREX
+- Display Extension
+- PAC-ID Resolver
+
+## Installation
+You can install LabFREED from [PyPI](https://pypi.org/project/labfreed/) using pip:
+
+```bash
+pip install labfreed
+```
+
+
+## Usage Examples
+> ⚠️ **Note:** These examples are building on each other. Imports and parsing are not repeated in each example.
+<!-- BEGIN EXAMPLES -->
+```python
+# import built ins
+import os
+```
+### Parse a simple PAC-ID
+
+```python
+from labfreed.IO.parse_pac import PAC_Parser
+
+
+# Parse the PAC-ID
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
+pac_id = PAC_Parser().parse(pac_str).pac_id
+
+# Check validity of this PAC-ID
+is_valid = pac_id.is_valid()
+print(f'PAC-ID is valid: {is_valid}')
+```
+```text
+>> PAC-ID is valid: True
+```
+### Show recommendations:
+Note that the PAC-ID -- while valid -- uses characters which are not recommended (results in larger QR code).
+There is a nice function to highlight problems
+
+```python
+pac_id.print_validation_messages(target='markdown')
+```
+```text
+>> Validation Results                                                       
+>> ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+>> │ RECOMMENDATION                                                                                                              │
+>> │ Characters l a b should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/🔸b🔸🔸a🔸🔸l🔸500/@1234                                                                      │
+>> ├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
+>> │ RECOMMENDATION                                                                                                              │
+>> │ Characters @ should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'      │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/bal500/🔸@🔸1234                                                                              │
+>> └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+```
+### Save as QR Code
+
+```python
+from labfreed.IO.generate_qr import save_qr_with_markers
+
+save_qr_with_markers(pac_str, fmt='png')
+```
+```text
+>> Large QR: Provided URL is not alphanumeric!
+>> Size: 29
+>> Version: 3
+>> Error Level: M
+```
+### PAC-CAT
+
+```python
+from labfreed.PAC_CAT.data_model import PAC_CAT
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-DR/XQ908756/-MD/bal500/@1234'
+pac_id = PAC_Parser().parse(pac_str).pac_id
+if isinstance(pac_id, PAC_CAT):
+    pac_id.print_categories()
+```
+```text
+>> Categories in           
+>> HTTPS://PAC.METTORIUS.COM/-DR/XQ90
+>>       8756/-MD/bal500/@1234       
+>> ┌────────────────────┬───────────┐
+>> │ Main Category      │           │
+>> │ key ()             │  -DR      │
+>> │ id (21)            │  XQ908756 │
+>> ├────────────────────┼───────────┤
+>> │ Category           │           │
+>> │ key ()             │  -MD      │
+>> │ model_number (240) │  bal500   │
+>> │ serial_number (21) │  @1234    │
+>> └────────────────────┴───────────┘
+```
+### Parse a PAC-ID with extensions
+PAC-ID can have extensions. Here we parse a PAC-ID with attached display names and summary.
+
+```python
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234*N$N/WM633OV3E5DGJW2BEG0PDM1EA7*SUM$TREX/WEIGHT$GRM:67.89'
+pac_id = PAC_Parser().parse(pac_str)
+
+# Display Name
+display_names = pac_id.get_extension('N') # display name has name 'N'
+print(display_names)
+```
+```text
+>> Display names: My Balance ❤️
+```
+```python
+# TREX
+trexes = pac_id.get_extension_of_type('TREX')
+trex = trexes[0] # there could be multiple trexes. In this example there is only one, though
+v = trex.get_segment('WEIGHT').to_python_type() 
+print(f'WEIGHT = {v}')
+```
+```text
+>> WEIGHT = 67.89 g
+```
+### Create a PAC-ID with Extensions
+
+#### Create PAC-ID
+
+```python
+from labfreed.PAC_ID.data_model import PACID, IDSegment
+from labfreed.utilities.well_known_keys import WellKnownKeys
+
+pac_id = PACID(issuer='METTORIUS.COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
+pac_str = pac_id.serialize()
+print(pac_str)
+```
+```text
+>> HTTPS://PAC.METTORIUS.COM/21:1234
+```
+#### Create a TREX 
+TREX can conveniently be created from a python dictionary.
+Note that utility types for Quantity (number with unit) and table are needed
+
+```python
+from datetime import datetime
+from labfreed.TREX.data_model import TREX
+from labfreed.utilities.utility_types import Quantity, DataTable, Unit
+
+# Create TREX
+trex = TREX(name_='DEMO') 
+# Add value segments of different type
+trex.update(   
+                    {
+                        'STOP': datetime(year=2024,month=5,day=5,hour=13,minute=6),
+                        'TEMP': Quantity(value=10.15, unit=Unit(name='kelvin', symbol='K')),
+                        'OK':False,
+                        'COMMENT': 'FOO',
+                        'COMMENT2':'£'
+                    }
+)
+
+# Create a table
+table = DataTable(['DURATION', 'Date', 'OK', 'COMMENT'])
+table.append([Quantity(value=1, unit=Unit(symbol='h', name='hour')), datetime.now(), True, 'FOO'])
+table.append([                                                 1.1,  datetime.now(), True, 'BAR'])
+table.append([                                                 1.3,  datetime.now(), False, 'BLUBB'])
+#add the table to the trex
+trex.update({'TABLE': table})
+
+# Validation also works the same way for TREX
+trex.print_validation_messages(target='markdown')
+```
+```text
+>> Validation Results                                                                                     
+>> ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+>> │ ERROR                                                                                                                                                                                   │
+>> │ Column header key contains invalid characters: e,a,t                                                                                                                                    │
+>> │ DEMO$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:D🔸a🔸🔸t🔸🔸e🔸$T.D:OK$T.B:COMMENT$T.A::1:20250411T090300.103:T:FOO::1… │
+>> └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+```
+```python
+# there is an error. 'Date' uses lower case. Lets fix it
+d = trex.dict()
+d['TABLE'].col_names[1] = 'DATE'
+trex = TREX(name_='DEMO') 
+trex.update(d)
+```
+#### Combine PAC-ID and TREX and serialize
+
+```python
+from labfreed.IO.parse_pac import PACID_With_Extensions
+
+pac_with_trex = PACID_With_Extensions(pac_id=pac_id, extensions=[trex])
+pac_str = pac_with_trex.serialize()
+print(pac_str)
+```
+```text
+>> HTTPS://PAC.METTORIUS.COM/21:1234*DEMO$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:DATE$T.D:OK$T.B:COMMENT$T.A::1:20250411T090300.103:T:FOO::1.1:20250411T090300.103:T:BAR::1.3:20250411T090300.103:F:BLUBB
+```
+## PAC-ID Resolver
+
+```python
+from labfreed.PAC_ID_Resolver.resolver import PAC_ID_Resolver, load_cit
+# Get a CIT
+dir = os.path.dirname(__file__)
+p = os.path.join(dir, 'cit_mine.yaml')       
+cit = load_cit(p)
+
+# validate the CIT
+cit.is_valid()
+cit.print_validation_messages()
+```
+```python
+# resolve a pac id
+service_groups = PAC_ID_Resolver(cits=[cit]).resolve(pac_with_trex)
+for sg in service_groups:
+    sg.update_states()
+    sg.print()
+    
+5
+```
+```text
+>> Request failed: HTTPSConnectionPool(host='aaaaaaaaaaaa.mettorius.com.com', port=443): Max retries exceeded with url: / (Caused by SSLError(SSLError(1, '[SSL: 
+>> SSLV3_ALERT_HANDSHAKE_FAILURE] sslv3 alert handshake failure (_ssl.c:1028)')))
+>>                             Services from origin 'MINE                            
+>> ┏━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
+>> ┃ Service Name             ┃ URL                                     ┃ Reachable ┃
+>> ┡━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
+>> │ AAAAAAAAAAAAAAAAAAhhhhhh │ https://AAAAAAAAAAAA.METTORIUS.COM.com/ │ INACTIVE  │
+>> └──────────────────────────┴─────────────────────────────────────────┴───────────┘
+>>            Services from origin 'PAC.METTORIUS.COM           
+>> ┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
+>> ┃ Service Name ┃ URL                            ┃ Reachable ┃
+>> ┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
+>> │ Shop         │ https://mettorius.com/shop/an= │ INACTIVE  │
+>> │ Manual       │ https://mettorius.com/om/an=   │ INACTIVE  │
+>> │ _3           │ https://mettorius.com/         │ ACTIVE    │
+>> └──────────────┴────────────────────────────────┴───────────┘
+```
+<!-- END EXAMPLES -->
+
+
+
+## Change Log
+
+### v0.1.1
+- minor internal improvements and bugfixes
+  
+### v0.1.0
+- DRAFT Support for PAC-ID Resolver
+
+### v0.0.20
+- bugfix in TREX table to dict conversion
+- markdown compatible validation printing 
+
+### v0.0.19
+- supports PAC-ID, PAC-CAT, TREX and DisplayName
+- QR generation 
+- ok-ish test coverage
+
+

{labfreed-0.1.0.dist-info → labfreed-0.1.1.dist-info}/RECORD

@@ -1,24 +1,24 @@
-labfreed/__init__.py,sha256=LebroXmoov8_KunUmdQn2n6f793Y9WSU58Q9C_6Dxz4,87
-labfreed/validation.py,sha256=PW08_mVpp27Bju3MblACHXupAXbl60GjRaSGXw161pU,6442
+labfreed/__init__.py,sha256=TzQ186YXdEkFSNsduP7q0XO3d8HEiNMNkHMZ6t6Zg-Y,87
+labfreed/validation.py,sha256=29Ys6qrCQ4T689juc19aiNJfHEgggI-hO7gfwrrNKWI,9554
 labfreed/DisplayNameExtension/DisplayNameExtension.py,sha256=l9JZY2eRS0V-H5h3-WXIHiiBJuljns-_e_t9Bp84_CU,1155
 labfreed/IO/generate_qr.py,sha256=wdZSf51Id03xSY8liK2RfB7WyGAw9O4s0VhZzrkAa-g,16680
-labfreed/IO/parse_pac.py,sha256=fZKNWuVGnYZCY0k6xVB1JOmLN5g6D8RW5CIq6-6Y9KM,6288
+labfreed/IO/parse_pac.py,sha256=1rV-pJ4kUgxQMDl8DJ14SUmHV37ruKYZYBqiJjPtCUw,6381
 labfreed/PAC_CAT/__init__.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-labfreed/PAC_CAT/data_model.py,sha256=qPrpzooI5tmH9P5JxfHWn0Ruung66gJ9KojCu5lXVzY,14320
+labfreed/PAC_CAT/data_model.py,sha256=9cjLA7u4APtiFbZyYp9iuYhl5mOGUPS30gXwYl0G_24,15153
 labfreed/PAC_ID/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-labfreed/PAC_ID/data_model.py,sha256=vALf8thR4zq7WrVZaKnIiS8hGBJ7UuKoy2heOY97tOs,7481
+labfreed/PAC_ID/data_model.py,sha256=IZB6F2p3E90mEalnYdGjPvMGcuvNWOrqqlKXGuDyJQ4,7601
 labfreed/PAC_ID/extensions.py,sha256=YKIE-aFf1jdL4sqCqUe3txjnP8-dA2zCJrT5lBSjvuE,1092
-labfreed/PAC_ID_Resolver/cit.yaml,sha256=-UcP-vKwhwGmYZVkVOjPZWEwHPzxUDcTFZFVM2_zMF0,2017
-labfreed/PAC_ID_Resolver/data_types.py,sha256=i9F4FzLdAUpcFIX9fg9bLFRqQRe0E2ptb17etdtsj_c,1609
+labfreed/PAC_ID_Resolver/cit.yaml,sha256=G_cH1f0Z7MUGgu7YR1cVhTrETaSBHvTVC7sbTbUJ-Rc,1992
+labfreed/PAC_ID_Resolver/data_types.py,sha256=XFUmlw-sGLbYNdHdyb-8SZMK6BwMMQWKuLfIGO-yR3g,2650
 labfreed/PAC_ID_Resolver/resolver.py,sha256=2EKpDEzOM8Ri-Gy5cKVE6aoHsVFRqZE9fd_llG4wrFI,8178
 labfreed/TREX/UneceUnits.json,sha256=kwfQSp_nTuWbADfBBgqTWrvPl6XtM5SedEVLbMJrM7M,898953
-labfreed/TREX/data_model.py,sha256=tGgjp76wbS1MSS1Ep842CZyintsbecTZrlapj8WwGH8,29704
+labfreed/TREX/data_model.py,sha256=etb4dd2kNFGDU5upQkH1YhlutRsvblMst4FdHQyuDu0,29972
 labfreed/TREX/parse.py,sha256=86962VEJpkrTcT436iFIB5dNed5WHABzpjxRjkA3PXo,2043
 labfreed/TREX/unece_units.py,sha256=scPKdsPzY1neAdFOhA08_tRZaR-yplM8mBhIzzDqZBk,3006
 labfreed/utilities/base36.py,sha256=_yX8aQ1OwrK5tnJU1NUEzQSFGr9xAVnNvPObpNzCPYs,2895
 labfreed/utilities/utility_types.py,sha256=dM0qZgshF3cHJThVzia7UIAOdkNLKukAaaduLqKSaMY,2195
 labfreed/utilities/well_known_keys.py,sha256=nqk66kHdSwJTJfMKlP-xQbBglS8F_NoWsGkfOVITFN0,331
-labfreed-0.1.0.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
-labfreed-0.1.0.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
-labfreed-0.1.0.dist-info/METADATA,sha256=bTILYvmhLnxvXo2HM9EBlwmOQttglU5Hc-Bk9dKKWcY,7625
-labfreed-0.1.0.dist-info/RECORD,,
+labfreed-0.1.1.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
+labfreed-0.1.1.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
+labfreed-0.1.1.dist-info/METADATA,sha256=uxdO6fEUnZPsWnW_sTZD34ptdj9xBPIXlUPk0mJQI6c,13103
+labfreed-0.1.1.dist-info/RECORD,,

labfreed-0.1.0.dist-info/METADATA

@@ -1,266 +0,0 @@
-Metadata-Version: 2.4
-Name: labfreed
-Version: 0.1.0
-Summary: Python implementation of LabFREED building blocks
-Author-email: Reto Thürer <thuerer.r@buchi.com>
-Description-Content-Type: text/markdown
-License-Expression: MIT
-License-File: LICENSE
-Requires-Dist: numpy>=2.2.4
-Requires-Dist: pydantic>=2.11.3
-Requires-Dist: segno>=1.6.6
-Requires-Dist: typer>=0.15.2
-
-# LabFREED for Python
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![PyPI](https://img.shields.io/pypi/v/labfreed.svg)](https://pypi.org/project/labfreed/) ![Python Version](https://img.shields.io/pypi/pyversions/labfreed)
-
-<!--
-[![Tests](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml/badge.svg)](https://github.com/retothuerer/LabFREED/actions/workflows/ci.yml)
--->
-
-This is a Python implementation of [LabFREED](https://labfreed.wega-it.com) building blocks.
-
-## Supported Building Blocks
-- PAC-ID
-- PAC-CAT
-- TREX
-- Display Extension
-
-## Installation
-You can install LabFREED from [PyPI](https://pypi.org/project/labfreed/) using pip:
-
-```bash
-pip install labfreed
-```
-
-
-## Usage Examples
-> ⚠️ **Note:** These examples are building on each other. Imports and parsing are not repeated in each example.
-<!-- BEGIN EXAMPLES -->
-```python
-# import built ins
-import os
-```
-### Parse a simple PAC-ID
-
-```python
-from labfreed.IO.parse_pac import PAC_Parser
-
-
-# Parse the PAC-ID
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
-pac_id = PAC_Parser().parse(pac_str).pac_id
-
-# Check validity of this PAC-ID
-pac_id = PAC_Parser().parse(pac_str).pac_id
-is_valid = pac_id.is_valid()
-print(f'PAC-ID is valid: {is_valid}')
-```
-```text
->> PAC-ID is valid: True
-```
-### Show recommendations:
-Note that the PAC-ID -- while valid -- uses characters which are not recommended (results in larger QR code).
-There is a nice function to highlight problems
-
-```python
-pac_id.print_validation_messages(target='markdown')
-```
-```text
->> =======================================
->> Validation Results
->> ---------------------------------------
->> 
->>  Recommendation  in      id segment value bal500
->> HTTPS://PAC.METTORIUS.COM/-MD/🔸b🔸🔸a🔸🔸l🔸500/@1234
->> Characters a b l should not be used.
->> 
->>  Recommendation  in      id segment value @1234
->> HTTPS://PAC.METTORIUS.COM/-MD/bal500/🔸@🔸1234
->> Characters @ should not be used.
->> 
->>  Warning  in     Category -MD
->> HTTPS://PAC.METTORIUS.COM/🔸-MD🔸/bal500/@1234
->> Category key -MD is not a well known key. It is recommended to use well known keys only
-```
-### Save as QR Code
-
-```python
-from labfreed.IO.generate_qr import save_qr_with_markers
-
-save_qr_with_markers(pac_str, fmt='png')
-```
-```text
->> Large QR: Provided URL is not alphanumeric!
->> Size: 29
->> Version: 3
->> Error Level: M
-```
-### PAC-CAT
-
-```python
-from labfreed.PAC_CAT.data_model import PAC_CAT
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-DR/XQ908756/-MD/bal500/@1234'
-pac_id = PAC_Parser().parse(pac_str).pac_id
-if isinstance(pac_id, PAC_CAT):
-    pac_id.print_categories()
-```
-```text
->> Main Category
->> ----------
->> key 	 (): 	 -DR
->> id 	 (21): 	 XQ908756
->> Category
->> ------ 
->> key 	 (): 	 -MD
->> model_number 	 (240): 	 bal500
->> serial_number 	 (21): 	 @1234
-```
-### Parse a PAC-ID with extensions
-PAC-ID can have extensions. Here we parse a PAC-ID with attached display names and summary.
-
-```python
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234*N$N/WM633OV3E5DGJW2BEG0PDM1EA7*SUM$TREX/WEIGHT$GRM:67.89'
-pac_id = PAC_Parser().parse(pac_str)
-
-# Display Name
-display_names = pac_id.get_extension('N') # display name has name 'N'
-print(display_names)
-```
-```text
->> Display names: My Balance ❤️
-```
-```python
-# TREX
-trexes = pac_id.get_extension_of_type('TREX')
-trex = trexes[0] # there could be multiple trexes. In this example there is only one, though
-v = trex.get_segment('WEIGHT').to_python_type() 
-print(f'WEIGHT = {v}')
-```
-```text
->> WEIGHT = 67.89 g
-```
-### Create a PAC-ID with Extensions
-
-#### Create PAC-ID
-
-```python
-from labfreed.PAC_ID.data_model import PACID, IDSegment
-from labfreed.utilities.well_known_keys import WellKnownKeys
-
-pac_id = PACID(issuer='METTORIUS.COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
-pac_str = pac_id.serialize()
-print(pac_str)
-```
-```text
->> HTTPS://PAC.METTORIUS.COM/21:1234
-```
-#### Create a TREX 
-TREX can conveniently be created from a python dictionary.
-Note that utility types for Quantity (number with unit) and table are needed
-
-```python
-from datetime import datetime
-from labfreed.TREX.data_model import TREX
-from labfreed.utilities.utility_types import Quantity, DataTable, Unit
-
-# Create TREX
-trex = TREX(name_='DEMO') 
-# Add value segments of different type
-trex.update(   
-                    {
-                        'STOP': datetime(year=2024,month=5,day=5,hour=13,minute=6),
-                        'TEMP': Quantity(value=10.15, unit=Unit(name='kelvin', symbol='K')),
-                        'OK':False,
-                        'COMMENT': 'FOO',
-                        'COMMENT2':'£'
-                    }
-)
-
-# Create a table
-table = DataTable(['DURATION', 'Date', 'OK', 'COMMENT'])
-table.append([Quantity(value=1, unit=Unit(symbol='h', name='hour')), datetime.now(), True, 'FOO'])
-table.append([                                                 1.1,  datetime.now(), True, 'BAR'])
-table.append([                                                 1.3,  datetime.now(), False, 'BLUBB'])
-#add the table to the trex
-trex.update({'TABLE': table})
-
-# Validation also works the same way for TREX
-trex.print_validation_messages(target='markdown')
-```
-```text
->> =======================================
->> Validation Results
->> ---------------------------------------
->> 
->>  Error  in       TREX table column Date
->> DEMO$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:D🔸a🔸🔸t🔸🔸e🔸$T.D:OK$T.B:COMMENT$T.A::1:20250410T094130.847:T:FOO::1.1:20250410T094130.847:T:BAR::1.3
->> :20250410T094130.847:F:BLUBB
->> Column header key contains invalid characters: t,a,e
-```
-```python
-# there is an error. 'Date' uses lower case. Lets fix it
-d = trex.dict()
-d['TABLE'].col_names[1] = 'DATE'
-trex = TREX(name_='DEMO') 
-trex.update(d)
-```
-#### Combine PAC-ID and TREX and serialize
-
-```python
-from labfreed.IO.parse_pac import PACID_With_Extensions
-
-pac_with_trex = PACID_With_Extensions(pac_id=pac_id, extensions=[trex])
-pac_str = pac_with_trex.serialize()
-print(pac_str)
-```
-```text
->> HTTPS://PAC.METTORIUS.COM/21:1234*DEMO$TREX/STOP$T.D:20240505T1306+TEMP$KEL:10.15+OK$T.B:F+COMMENT$T.A:FOO+COMMENT2$T.T:12G3+TABLE$$DURATION$HUR:DATE$T.D:OK$T.B:COMMENT$T.A::1:20250410T094130.847:T:FOO::1.1:20250410T094130.847:T:BAR::1.3:20250410T094130.847:F:BLUBB
-```
-## PAC-ID Resolver
-
-```python
-from labfreed.PAC_ID_Resolver.resolver import PAC_ID_Resolver, load_cit
-# Get a CIT
-dir = os.path.dirname(__file__)
-p = os.path.join(dir, 'cit_mine.yaml')       
-cit = load_cit(p)
-
-# validate the CIT
-cit.is_valid()
-cit.print_validation_messages()
-```
-```text
->> [Error during execution: name '__file__' is not defined]
-```
-```python
-# resolve a pac id
-service_groups = PAC_ID_Resolver(cits=[cit]).resolve(pac_with_trex)
-for sg in service_groups:
-    sg.print()
-    
-5
-```
-```text
->> [Error during execution: name 'cit' is not defined]
-```
-<!-- END EXAMPLES -->
-
-
-
-## Change Log
-
-### v0.1.0
-- DRAFT Support for PAC-ID Resolver
-
-### v0.0.20
-- bugfix in TREX table to dict conversion
-- markdown compatible validation printing 
-
-### v0.0.19
-- supports PAC-ID, PAC-CAT, TREX and DisplayName
-- QR generation 
-- ok-ish test coverage
-
-