labfreed 0.2.6a6__tar.gz → 0.2.8__tar.gz

{labfreed-0.2.6a6 → labfreed-0.2.8}/LICENSE

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2025 Reto Thürer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2025 Reto Thürer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

{labfreed-0.2.6a6 → labfreed-0.2.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labfreed
-Version: 0.2.6a6
+Version: 0.2.8
 Summary: Python implementation of LabFREED building blocks
 Author-email: Reto Thürer <thuerer.r@buchi.com>
 Requires-Python: >=3.11
@@ -23,6 +23,7 @@ Requires-Dist: typer>=0.15.2
 Requires-Dist: PyYAML>=6.0.2
 Requires-Dist: jsonpath-ng>=1.7.0
 Requires-Dist: requests>=2.32.3
+Requires-Dist: requests_cache>=1.2.1
 Requires-Dist: pytest>=8.3.5 ; extra == "dev"
 Requires-Dist: pdoc>=15.0.1 ; extra == "dev"
 Requires-Dist: flit>=3.12.0 ; extra == "dev"
@@ -38,7 +39,7 @@ Provides-Extra: dev
 [![PyPI](https://img.shields.io/pypi/v/labfreed.svg)](https://pypi.org/project/labfreed/) ![Python Version](https://img.shields.io/pypi/pyversions/labfreed) [![Test Labfreed](https://github.com/retothuerer/LabFREED/actions/workflows/run-tests.yml/badge.svg)](https://github.com/retothuerer/LabFREED/actions/workflows/run-tests.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) 
 
 
-This is a Python implementation of [LabFREED](https://labfreed.wega-it.com) building blocks.
+This is a Python implementation of [LabFREED](https://labfreed.org/) building blocks.
 
 ## Supported Building Blocks
 - PAC-ID
@@ -53,7 +54,7 @@ This is a Python implementation of [LabFREED](https://labfreed.wega-it.com) buil
   - base36 <> str conversions
 - PAC-ID Resolver
   - support for CIT v1
-  - draft support for CIT v1 (improved version)
+  - draft support for CIT v2 (improved version)
   - combined use of multiple cit in any combination of version
 - Generation of QR codes (PAC-ID with extensions)
   
@@ -107,22 +108,22 @@ pac.print_validation_messages()
 >> │ **RECOMMENDATION** in id segment value bal500                                                                                     │
 >> │ Characters 'b','l','a' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
 >> │                                                                                                                                   │
->> │ HTTPS://PAC.METTORIUS.COM/-MD/240:👉bal👈500/21:@1234                                                                             │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/👉bal👈500/@1234                                                                                    │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
 >> │ **RECOMMENDATION** in id segment value @1234                                                                                      │
 >> │ Characters '@' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'          │
 >> │                                                                                                                                   │
->> │ HTTPS://PAC.METTORIUS.COM/-MD/240:bal500/21:👉@👈1234                                                                             │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/bal500/👉@👈1234                                                                                    │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
 >> │ **RECOMMENDATION** in id segment value bal500                                                                                     │
 >> │ Characters 'b','l','a' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'  │
 >> │                                                                                                                                   │
->> │ HTTPS://PAC.METTORIUS.COM/-MD/240:👉bal👈500/21:@1234                                                                             │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/👉bal👈500/@1234                                                                                    │
 >> ├───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
 >> │ **RECOMMENDATION** in id segment value @1234                                                                                      │
 >> │ Characters '@' should not be used., Characters SHOULD be limited to upper case letters (A-Z), numbers (0-9), '-' and '+'          │
 >> │                                                                                                                                   │
->> │ HTTPS://PAC.METTORIUS.COM/-MD/240:bal500/21:👉@👈1234                                                                             │
+>> │ HTTPS://PAC.METTORIUS.COM/-MD/bal500/👉@👈1234                                                                                    │
 >> └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
 ```
 ### Save as QR Code
@@ -152,8 +153,8 @@ if isinstance(pac, PAC_CAT):
 ```
 ```text
 >> Categories in           
->> HTTPS://PAC.METTORIUS.COM/-MD/240:
->>          bal500/21:@1234          
+>> HTTPS://PAC.METTORIUS.COM/-DR/XQ90
+>>       8756/-MD/bal500/@1234       
 >> ┌────────────────────┬───────────┐
 >> │ Main Category      │           │
 >> │ key ()             │  -DR      │
@@ -248,7 +249,7 @@ trex.print_validation_messages()
 >> Validation Results                                            
 >> ┌────────────────────────────────────────────────────────────┐
 >> │ **ERROR** in TREX table column Date                        │
->> │ Column header key contains invalid characters: 'e','a','t' │
+>> │ Column header key contains invalid characters: 't','e','a' │
 >> │                                                            │
 >> │ STOP$T.D:20240505T1306                                     │
 >> │ +TEMP$KEL:10.15                                            │
@@ -256,9 +257,9 @@ trex.print_validation_messages()
 >> │ +COMMENT$T.A:FOO                                           │
 >> │ +COMMENT2$T.T:12G3                                         │
 >> │ +TABLE$$DURATION$HUR:D👉ate👈$T.D:OK$T.B:COMMENT$T.A::     │
->> │  1:20250430T100239.279:T:FOO::                             │
->> │  1.1:20250430T100239.280:T:BAR::                           │
->> │  1.3:20250430T100239.280:F:BLUBB                           │
+>> │  1:20250514T102232.171:T:FOO::                             │
+>> │  1.1:20250514T102232.171:T:BAR::                           │
+>> │  1.3:20250514T102232.171:F:BLUBB                           │
 >> └────────────────────────────────────────────────────────────┘
 ```
 #### Combine PAC-ID and TREX and serialize
@@ -270,12 +271,14 @@ pac_str = pac.to_url()
 print(pac_str)
 ```
 ```text
->> HTTPS://PAC.METTORIUS.COM/21:1234*MYTREX$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:20250430T100239.279:T:FOO::1.1:20250430T100239.280:T:BAR::1.3:20250430T100239.280:F:BLUBB
+>> HTTPS://PAC.METTORIUS.COM/21:1234*MYTREX$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:20250514T102232.171:T:FOO::1.1:20250514T102232.171:T:BAR::1.3:20250514T102232.171:F:BLUBB
 ```
 ## PAC-ID Resolver
 
 ```python
 from labfreed import PAC_ID_Resolver, load_cit  
+import requests_cache
+
 # Get a CIT
 dir = os.path.join(os.getcwd(), 'examples')
 p = os.path.join(dir, 'cit_mine.yaml')       
@@ -294,8 +297,10 @@ cit2.origin = 'MY_COMPANY'
 ```python
 # resolve a pac id
 pac_str = 'HTTPS://PAC.METTORIUS.COM/-MS/X3511/CAS:7732-18-5'
-service_groups = PAC_ID_Resolver(cits=[cit, cit2]).resolve(pac_str)
+service_groups = PAC_ID_Resolver(cits=[cit, cit2]).resolve(pac_str, check_service_status=False)
+cached_session = requests_cache.CachedSession(backend='memory', expire_after=60)
 for sg in service_groups:
+    sg.update_states(cached_session)
     sg.print()
     
 ```
@@ -306,12 +311,12 @@ for sg in service_groups:
 >> ┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
 >> │ CAS Search   │ https://pubchem.ncbi.nlm.nih.gov/#query=7732-18-5 │ ACTIVE    │
 >> └──────────────┴───────────────────────────────────────────────────┴───────────┘
->>                                     Services from origin 'MY_COMPANY                                    
->> ┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
->> ┃ Service Name        ┃ URL                                                                ┃ Reachable ┃
->> ┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
->> │ Chemical Management │ https://chem-manager.com/METTORIUS.COM/-MS/240:X3511/CAS:7732-18-5 │ INACTIVE  │
->> └─────────────────────┴────────────────────────────────────────────────────────────────────┴───────────┘
+>>                                   Services from origin 'MY_COMPANY                                  
+>> ┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
+>> ┃ Service Name        ┃ URL                                                            ┃ Reachable ┃
+>> ┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
+>> │ Chemical Management │ https://chem-manager.com/METTORIUS.COM/-MS/X3511/CAS:7732-18-5 │ INACTIVE  │
+>> └─────────────────────┴────────────────────────────────────────────────────────────────┴───────────┘
 >>              Services from origin 'METTORIUS.COM              
 >> ┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
 >> ┃ Service Name ┃ URL                             ┃ Reachable ┃
@@ -327,6 +332,16 @@ for sg in service_groups:
 
 <!-- BEGIN CHANGELOG -->
 ## Change Log
+### v0.2.8
+- option to pass cache to resolver for speedier check of service availability
+
+### v0.2.7
+- Improved README. No functional changes
+  
+### v0.2.6
+- PAC_ID.to_url() preserves the identifier as is by default but allows to force short or long notation.
+- PAC-ID Resolver does not try to resolve PAC-CAT with CIT v1.
+  
 ### v0.2.5
 - resolvers checks service states by default
 - improvements and bugfixes in conversion from python types to TREX