labfreed 0.0.10__tar.gz → 0.0.11__tar.gz

{labfreed-0.0.10 → labfreed-0.0.11}/PKG-INFO

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

labfreed-0.0.11/README.md

@@ -0,0 +1,152 @@
+# 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
+from datetime import datetime
+from typing import Annotated
+
+# Parse a PAC ID
+from labfreed.PAC_ID.data_model import PACID, IDSegment
+from labfreed.parse_pac import PAC_Parser, PACID_With_Extensions
+from utility_types import Quantity
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234'
+pac = PAC_Parser().parse_pac_id(pac_str)
+
+## Check validity
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/bal500/@1234'
+pac = PAC_Parser().parse_pac_id(pac_str)
+is_valid = pac.is_valid()
+print('PAC-ID is valid: {is_valid}')
+
+# Show recommendations
+pac.print_validation_messages()
+
+
+
+
+## Parse a PAC-ID with extensions
+pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234*N$N/WM633OV3E5DGJW2BEG0PDM1EA7*SUM$TREX/WEIGHT$GRM:67.89'
+pac = PAC_Parser().parse_pac_with_extensions(pac_str)
+
+# Display Name
+display_names = pac.get_extension('N')
+print(f'\nDisplay names: {display_names}')
+
+# TREX
+from labfreed.TREX.data_model import TREX, ColumnHeader, TREX_Table, TableRow
+trexes = pac.get_extension_of_type('TREX')
+trex:TREX = trexes[0]
+v = trex.get_segment('WEIGHT').to_python_type()
+
+
+
+
+## Create a PAC-ID
+from labfreed.utilities.well_known_keys import WellKnownKeys
+pac = PACID(issuer='METTORIUS:COM', identifier=[IDSegment(key=WellKnownKeys.SERIAL, value='1234')])
+pac_str = pac.serialize()
+pac_str = pac.serialize()
+print(pac_str)
+
+
+
+
+# create a TREX
+from labfreed.TREX.data_model import TREX, DateSegment, NumericSegment, BoolSegment, AlphanumericSegment, TextSegment, BinarySegment
+
+trex = TREX(name_='DEMO-TREX')
+
+trex.segments.append(DateSegment(key='START',value='20240505T1204'))
+trex.segments.append(DateSegment(key='STOP', value=datetime(year=2024,month=5,day=5,hour=13,minute=6)) )
+
+trex.segments.append(NumericSegment(key='TEMP',type='KEL', value=10.15) )
+trex.segments.append(BoolSegment(key='OK', value=False) )
+trex.segments.append(AlphanumericSegment(key='COMMENT', value='FOO') )
+trex.segments.append(TextSegment(key='COMMENT2', value='🐯') )
+trex.segments.append(TextSegment(key='COMMENT2', value='BAR') )
+
+# if the sting is already in base36 you have to be explicit
+from labfreed.utilities.base36 import base36
+trex.segments.append(TextSegment(key='COMMENT3', value=base36('1URIOQ7')) )
+
+# table
+table = TREX_Table(key='TABLE', 
+                   column_headers=[
+                                    ColumnHeader(key='COL1', type='HUR'), 
+                                    ColumnHeader(key='COL2', type='T.A'),
+                                    ColumnHeader(key='COL3', type='T.D'),
+                                    ColumnHeader(key='COL4', type='T.B')
+                                    ],
+                   data=[
+                       TableRow()
+                   ])
+trex.segments.append(table)
+
+if trex.is_valid():
+    print(trex.data)
+else:
+    trex.print_validation_messages()
+    
+
+p = PACID_With_Extensions(pac_id=pac, extensions=[trex])
+print(p.serialize())
+
+
+
+
+
+# for convenience a TREX can be created from a dict
+trex2 = TREX(name_='DEMO-TREX2')
+trex2.update(   
+                    {
+                        'STOP': datetime(year=2024,month=5,day=5,hour=13,minute=6),
+                        'TEMP': Quantity(value=10.15, unit_name='meter', unit_symbol='m'),
+                        'OK':False,
+                        'COMMENT': 'FOO',
+                        'COMMENT2':'🐯'
+                    }
+)
+
+d = trex2.dict()
+
+
+
+    
+
+
+
+
+
+```
+<!-- END EXAMPLES -->
+
+
+
+## Change Log
+
+### v0.0.9
+- supports PAC-ID, PAC-CAT, TREX and DisplayName
+- ok-ish test coverage

{labfreed-0.0.10 → labfreed-0.0.11}/labfreed/__init__.py

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

{labfreed-0.0.10 → labfreed-0.0.11}/publish.ps1

@@ -13,5 +13,5 @@ if ($target -eq "prod") {
     flit publish --repository pypi
 }
 else {
-    flit publish --repository pypi
+    flit publish --repository testpypi
 }

{labfreed-0.0.10 → labfreed-0.0.11}/pyproject.toml

@@ -12,7 +12,7 @@ dynamic = ["version", "description"]
 [tool.flit.module]
 name = "labfreed"
 
-readme = "README.md"
+readme = {file = "README.md", content-type = "text/markdown"}
 requires-python = ">=3.10"
 classifiers = [
     "Programming Language :: Python :: 3",

{labfreed-0.0.10 → labfreed-0.0.11}/update_readme.py

@@ -2,15 +2,18 @@
 start_marker = "<!-- BEGIN EXAMPLES -->"
 end_marker = "<!-- END EXAMPLES -->"
 
-with open("examples.py") as ex_file:
+with open("examples.py", encoding='utf-8') as ex_file:
     example_code = ex_file.read()
 
 # Optional: Format as Markdown code block
 example_code_md = f"```python\n{example_code}\n```"
 
-with open("README.md") as readme_file:
+with open("README.md", encoding='utf-8') as readme_file:
     readme = readme_file.read()
 
+if not readme:
+    raise ValueError('README.md is empty')
+
 # Replace the section between markers
 new_readme = (
     readme.split(start_marker)[0]
@@ -19,7 +22,6 @@ new_readme = (
     + end_marker
     + readme.split(end_marker)[1]
 )
-new_readme.replace
 
-with open("README.md", "w") as readme_file:
+with open("README.md", "w", encoding='utf-8') as readme_file:
     readme_file.write(new_readme)

labfreed-0.0.10/README.md

@@ -1,60 +0,0 @@
-# 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 PAC ID
-from labfreed.PAC_ID.parse import PAC_Parser
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234'
-pac = PAC_Parser().parse_pac_id(pac_str)
-
-## Check validity
-pac.is_valid()
-pac.print_validation_messages()
-
-
-## Parse a PAC-ID with extensions
-from labfreed.utilities.extension_intertpreters import well_known_interpreters as extension_interpreters
-pac_str = 'HTTPS://PAC.METTORIUS.COM/-MD/BAL500/1234*NAME$N/WM633OV3E5DGJW2BEG0PDM1EA7*SUM$TREX/WEIGHT$GRM:67.89'
-pac = PAC_Parser(extension_interpreters).parse_pac_id(pac_str)
-
-## Create a PAC-ID
-
-## Create a PAC-ID and T-REX for a titration curve
-
-
-
-```
-
-<!-- END EXAMPLES -->
-
-
-
-## Change Log
-
-### v0.0.9
-- supports PAC-ID, PAC-CAT, TREX and DisplayName
-- ok-ish test coverage