labfreed 0.0.13__py2.py3-none-any.whl → 0.0.15__py2.py3-none-any.whl

labfreed/__init__.py

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

labfreed/parse_pac.py

@@ -49,7 +49,7 @@ class PACID_With_Extensions(BaseModelWithValidationMessages):
     @classmethod
     def deserialize(cls, url, extension_interpreters ):
         parser = PAC_Parser(extension_interpreters)
-        return parser.parse_pac_with_extensions(url)
+        return parser.parse(url)
         
         
     
@@ -87,15 +87,15 @@ class PAC_Parser():
     def __init__(self, extension_interpreters:dict[str, Extension]=None):
         self.extension_interpreters = extension_interpreters or {'TREX': TREX, 'N': DisplayNames}
         
-    def parse_pac_with_extensions(self, pac_url:str) -> PACID_With_Extensions:
+    def parse(self, pac_url:str) -> PACID_With_Extensions:
         if '*' in pac_url:
             id_str, ext_str = pac_url.split('*', 1)
         else:
             id_str = pac_url
             ext_str = ""
             
-        pac_id = self.parse_pac_id(id_str)
-        extensions = self.parse_extensions(ext_str)
+        pac_id = self._parse_pac_id(id_str)
+        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():
@@ -104,7 +104,7 @@ class PAC_Parser():
         return pac_with_extension
             
             
-    def parse_pac_id(self,id_str:str) -> PACID:
+    def _parse_pac_id(self,id_str:str) -> PACID:
         m = re.match(f'(HTTPS://)?(PAC.)?(?P<issuer>.+?\..+?)/(?P<identifier>.*)', id_str)
         d = m.groupdict()
         
@@ -148,7 +148,7 @@ class PAC_Parser():
     
 
 
-    def parse_extensions(self, extensions_str:str|None) -> list[Extension]:    
+    def _parse_extensions(self, extensions_str:str|None) -> list[Extension]:    
         
         extensions = list()
         

labfreed-0.0.15.dist-info/METADATA

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: labfreed
+Version: 0.0.15
+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
+
+# 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](www.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
+<!-- BEGIN EXAMPLES -->
+```python
+
+```
+
+### Parse a simple PAC-ID 
+The
+
+```python
+from labfreed.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('PAC-ID is valid: {is_valid}')
+# >> PAC-ID is valid: {is_valid}
+```
+
+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()
+# >>
+#   =======================================
+#   Validation Results
+#   ---------------------------------------
+
+#   Recommendation  in      id segment value bal500
+#   HTTPS://PAC.METTORIUS.COM/-MD/bal500/@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
+```
+
+### 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(f'\n {display_names}')
+# >> Display names: My Balance ❤️
+
+# 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}')
+# >> 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()
+pac_str = pac_id.serialize()
+print(pac_str)
+```
+
+#### 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
+if trex.get_nested_validation_messages():
+    trex.print_validation_messages()
+
+# Side Note: The TREX can be turned back into a dict
+d = trex.dict()
+```
+
+#### Combine PAC-ID and TREX and serialize
+
+```python
+from labfreed.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)
+```
+
+<!-- END EXAMPLES -->
+
+
+
+## Change Log
+
+### v0.0.9
+- supports PAC-ID, PAC-CAT, TREX and DisplayName
+- ok-ish test coverage

{labfreed-0.0.13.dist-info → labfreed-0.0.15.dist-info}/RECORD

@@ -1,5 +1,5 @@
-labfreed/__init__.py,sha256=dbzHl7p-INUVLH3QhiaeR2a9v2bj6oIXYGEEDkDun-w,88
-labfreed/parse_pac.py,sha256=HA3-jAnw2crsXMW_D7Tw-z99qnUWL5MBQVXEzdYP2m4,6287
+labfreed/__init__.py,sha256=2kxIKF8hbBacIqi0RgHcYqemImSCpb62ejkGUuOMMkY,88
+labfreed/parse_pac.py,sha256=7y65HO1A3OEr5zftiEtrCaiLLI_8LoRPtQpPcKUNVik,6251
 labfreed/validation.py,sha256=QwkZWJhAjWbPUZtJJwjVYsw9TxeFhdbZaKjrPPIpuAA,5937
 labfreed/DisplayNameExtension/DisplayNameExtension.py,sha256=l9JZY2eRS0V-H5h3-WXIHiiBJuljns-_e_t9Bp84_CU,1155
 labfreed/PAC_CAT/__init__.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
@@ -16,7 +16,7 @@ labfreed/utilities/base36.py,sha256=_yX8aQ1OwrK5tnJU1NUEzQSFGr9xAVnNvPObpNzCPYs,
 labfreed/utilities/extension_intertpreters.py,sha256=B3IFJLfVMJQuPfBBtX6ywlDUZEi7_x6tY4g8V7SpWSs,124
 labfreed/utilities/utility_types.py,sha256=Zhk8Mu4hHjkn1gs8oh7vOxxaT7L7wLMVG40ZOWCKGK4,2865
 labfreed/utilities/well_known_keys.py,sha256=nqk66kHdSwJTJfMKlP-xQbBglS8F_NoWsGkfOVITFN0,331
-labfreed-0.0.13.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
-labfreed-0.0.13.dist-info/WHEEL,sha256=BXjIu84EnBiZ4HkNUBN93Hamt5EPQMQ6VkF7-VZ_Pu0,100
-labfreed-0.0.13.dist-info/METADATA,sha256=rJEL0un8Nk5O856HzhtdFAMmoSqOmkEqprrOerf-5HY,207
-labfreed-0.0.13.dist-info/RECORD,,
+labfreed-0.0.15.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
+labfreed-0.0.15.dist-info/WHEEL,sha256=BXjIu84EnBiZ4HkNUBN93Hamt5EPQMQ6VkF7-VZ_Pu0,100
+labfreed-0.0.15.dist-info/METADATA,sha256=dxqZ7E2CeiqTaYKXuDLn4mxRSv3mH9aqRH96CS2EfFw,4997
+labfreed-0.0.15.dist-info/RECORD,,

labfreed-0.0.13.dist-info/METADATA

@@ -1,7 +0,0 @@
-Metadata-Version: 2.4
-Name: labfreed
-Version: 0.0.13
-Summary: Python implementation of LabFREED building blocks
-Author-email: Reto Thürer <thuerer.r@buchi.com>
-License-Expression: MIT
-License-File: LICENSE