vtlengine 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

vtlengine/files/parser/_time_checking.py

@@ -7,83 +7,92 @@ from vtlengine.DataTypes.TimeHandling import TimePeriodHandler
 from vtlengine.Exceptions import InputValidationException
 
 
-def check_date(value: str):
+def check_date(value: str) -> str:
     """
     Check if the date is in the correct format.
     """
     # Remove all whitespaces
     value = value.replace(" ", "")
     try:
-        if len(value) == 9 and value[7] == '-':
-            value = value[:-1] + '0' + value[-1]
+        if len(value) == 9 and value[7] == "-":
+            value = value[:-1] + "0" + value[-1]
         date_value = date.fromisoformat(value)
     except ValueError as e:
-        if 'is out of range' in str(e):
+        if "is out of range" in str(e):
             raise InputValidationException(f"Date {value} is out of range for the month.")
-        if 'month must be in 1..12' in str(e):
-            raise InputValidationException(f"Date {value} is invalid. "
-                                           f"Month must be between 1 and 12.")
-        raise InputValidationException(f"Date {value} is not in the correct format. "
-                                       f"Use YYYY-MM-DD.")
+        if "month must be in 1..12" in str(e):
+            raise InputValidationException(
+                f"Date {value} is invalid. " f"Month must be between 1 and 12."
+            )
+        raise InputValidationException(
+            f"Date {value} is not in the correct format. " f"Use YYYY-MM-DD."
+        )
 
     # Check date is between 1900 and 9999
     if not 1800 <= date_value.year <= 9999:
-        raise InputValidationException(f"Date {value} is invalid. "
-                                       f"Year must be between 1900 and 9999.")
+        raise InputValidationException(
+            f"Date {value} is invalid. " f"Year must be between 1900 and 9999."
+        )
 
     return date_value.isoformat()
 
 
-def dates_to_string(date1, date2):
-    date1_str = date1.strftime('%Y-%m-%d')
-    date2_str = date2.strftime('%Y-%m-%d')
+def dates_to_string(date1: date, date2: date) -> str:
+    date1_str = date1.strftime("%Y-%m-%d")
+    date2_str = date2.strftime("%Y-%m-%d")
     return f"{date1_str}/{date2_str}"
 
 
-date_pattern = r'\d{4}[-][0-1]?\d[-][0-3]?\d'
-year_pattern = r'\d{4}'
-month_pattern = r'\d{4}[-][0-1]?\d'
-time_pattern = r'^' + date_pattern + r'/' + date_pattern + r'$'
+date_pattern = r"\d{4}[-][0-1]?\d[-][0-3]?\d"
+year_pattern = r"\d{4}"
+month_pattern = r"\d{4}[-][0-1]?\d"
+time_pattern = r"^" + date_pattern + r"/" + date_pattern + r"$"
 
 
-def check_time(value: str):
+def check_time(value: str) -> str:
     value = value.replace(" ", "")
     year_result = re.fullmatch(year_pattern, value)
     if year_result is not None:
-        date1_time = datetime.strptime(value, '%Y')
+        date1_time = datetime.strptime(value, "%Y")
         date2_time = date1_time.replace(day=31, month=12)
         return dates_to_string(date1_time, date2_time)
     month_result = re.fullmatch(month_pattern, value)
     if month_result is not None:
-        date1_time = datetime.strptime(value, '%Y-%m')
+        date1_time = datetime.strptime(value, "%Y-%m")
         last_month_day = calendar.monthrange(date1_time.year, date1_time.month)[1]
         date2_time = date1_time.replace(day=last_month_day)
         return dates_to_string(date1_time, date2_time)
     time_result = re.fullmatch(time_pattern, value)
     if time_result is not None:
-        time_list = value.split('/')
+        time_list = value.split("/")
         if time_list[0] > time_list[1]:
             raise ValueError("Start date is greater than end date.")
         return value
-    raise ValueError("Time is not in the correct format. "
-                     "Use YYYY-MM-DD/YYYY-MM-DD or YYYY or YYYY-MM.")
+    raise ValueError(
+        "Time is not in the correct format. " "Use YYYY-MM-DD/YYYY-MM-DD or YYYY or YYYY-MM."
+    )
 
 
-day_period_pattern = r'^\d{4}[-][0-1]?\d[-][0-3]?\d$'
-month_period_pattern = r'^\d{4}[-][0-1]?\d$'
-year_period_pattern = r'^\d{4}$'
-period_pattern = r'^\d{4}[A]$|^\d{4}[S][1-2]$|^\d{4}[Q][1-4]$|^\d{4}[M][0-1]?\d$|^\d{4}[W][0-5]?\d$|^\d{4}[D][0-3]?[0-9]?\d$'
+day_period_pattern = r"^\d{4}[-][0-1]?\d[-][0-3]?\d$"
+month_period_pattern = r"^\d{4}[-][0-1]?\d$"
+year_period_pattern = r"^\d{4}$"
+period_pattern = (
+    r"^\d{4}[A]$|^\d{4}[S][1-2]$|^\d{4}[Q][1-4]$|^\d{4}[M]"
+    r"[0-1]?\d$|^\d{4}[W][0-5]?\d$|^\d{4}[D][0-3]?[0-9]?\d$"
+)
 
 # Related with gitlab issue #440, we can say that period pattern
 # matches with our internal representation (or vtl user manual)
 # and further_options_period_pattern matches
 # with other kinds of inputs that we have to accept for the period.
-further_options_period_pattern = (r'\d{4}-\d{2}-\d{2}|^\d{4}-D[0-3]\d\d$|^\d{4}-W([0-4]'
-                                  r'\d|5[0-3])|^\d{4}-(0[1-9]|1[0-2]|M(0[1-9]|1[0-2]|[1-9]))$|^'
-                                  r'\d{4}-Q[1-4]$|^\d{4}-S[1-2]$|^\d{4}-A1$')
+further_options_period_pattern = (
+    r"\d{4}-\d{2}-\d{2}|^\d{4}-D[0-3]\d\d$|^\d{4}-W([0-4]"
+    r"\d|5[0-3])|^\d{4}-(0[1-9]|1[0-2]|M(0[1-9]|1[0-2]|[1-9]))$|^"
+    r"\d{4}-Q[1-4]$|^\d{4}-S[1-2]$|^\d{4}-A1$"
+)
 
 
-def check_time_period(value: str):
+def check_time_period(value: str) -> str:
     value = value.replace(" ", "")
     period_result = re.fullmatch(period_pattern, value)
     if period_result is not None:
@@ -99,22 +108,22 @@ def check_time_period(value: str):
 
     year_result = re.fullmatch(year_period_pattern, value)
     if year_result is not None:
-        year = datetime.strptime(value, '%Y')
+        year = datetime.strptime(value, "%Y")
         year_period_wo_A = str(year.year)
         return year_period_wo_A
         # return year_period
 
     month_result = re.fullmatch(month_period_pattern, value)
     if month_result is not None:
-        month = datetime.strptime(value, '%Y-%m')
-        month_period = month.strftime('%YM%m')
+        month = datetime.strptime(value, "%Y-%m")
+        month_period = month.strftime("%YM%m")
         result = TimePeriodHandler(month_period)
         return str(result)
 
     # TODO: Do we use this?
     day_result = re.fullmatch(day_period_pattern, value)
     if day_result is not None:
-        day = datetime.strptime(value, '%Y-%m-%d')
-        day_period = day.strftime('%YD%-j')
+        day = datetime.strptime(value, "%Y-%m-%d")
+        day_period = day.strftime("%YD%-j")
         return day_period
     raise ValueError

vtlengine-1.0.1.dist-info/METADATA

@@ -0,0 +1,236 @@
+Metadata-Version: 2.1
+Name: vtlengine
+Version: 1.0.1
+Summary: Run and Validate VTL Scripts
+License: AGPL-3.0
+Author: MeaningfulData
+Author-email: info@meaningfuldata.eu
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: antlr4-python3-runtime (==4.9.2)
+Requires-Dist: bottleneck (>=1.3.4,<2.0.0)
+Requires-Dist: duckdb (>=1.1.1,<2.0.0)
+Requires-Dist: networkx (>=2.8.8,<3.0.0)
+Requires-Dist: numba (>=0.60.0,<0.61.0)
+Requires-Dist: numexpr (>=2.9.0,<3.0.0)
+Requires-Dist: pandas (>=2.1.4,<3.0.0)
+Requires-Dist: pyarrow (>=17.0.0,<18.0.0)
+Requires-Dist: s3fs (>=2024.9.0,<2025.0.0)
+Requires-Dist: sqlglot (>=22.2.0,<23.0.0)
+Description-Content-Type: text/markdown
+
+# VTL Engine
+
+## Introduction
+
+The VTL Engine is a Python library for validating and running VTL scripts.
+
+It is a Python-based library around the [VTL Language](http://sdmx.org/?page_id=5096).
+
+## Installation
+
+### Requirements
+
+The VTL Engine requires Python 3.10 or higher.
+
+### Install with pip
+
+To install the VTL Engine on any Operating System, you can use pip:
+
+```bash
+
+pip install vtlengine
+
+```
+
+*Note: it is recommended to install the VTL Engine in a virtual environment.*
+
+## Usage
+
+The VTL Engine API implements two basic methods:
+
+* **Semantic Analysis**: aimed at validating the correctness of a script and computing the data
+  structures of the data sets created in the script.
+* **Run**: aimed at executing the provided input on the provided input datasets.
+
+Any action with VTL requires the following elements as input:
+
+* **VTL Script**: Is the VTL to be executed, which includes the transformation scheme, as well as de
+  User Defined Operators, Hierarchical Rulesets and Datapoint Rulesets. It is provided as a string
+  or as a Path object to a vtl file.
+* **Data structures** : Provides the structure of the input artifacts of the VTL script, according to
+  the VTL Information model. Given that the current version doesn't prescribe a standard format for
+  providing the information, the VTL Engine is implementing a JSON format that can be found here.
+  Data Structures can be provided as Dictionaries or as Paths to JSON files. It is possible to have
+* **External routines**: The VTL Engine allows using SQL (SQLite) with the eval operator. Can be
+  provided as a string with the SQL or as a path object to an SQL file. Its default value is `None`,
+  which shall be used if external routines are not applicable to the VTL script.
+* **Value domains**: Provides the value domains that are used in the VTL script, normally with an in
+  operator. Can be provided as a dictionary or as a path to a JSON file. Its default value
+  is `None`, which shall be used if value domains are not applicable to the VTL script.
+
+### Semantic Analysis
+
+The `semantic_analysis` method serves to validate the correctness of a VTL script, as well as to
+calculate the data structures of the datasets generated by the VTL script itself (that calculation
+is a pre-requisite for the semantic analysis).
+
+* If the VTL script is correct, the method returns a dictionary with the data structures of all the
+  datasets generated by the script.
+* If the VTL script is incorrect, raises a VTL Engine custom error Explaining the error.
+
+#### Example 1: Correct VTL
+
+```python
+from vtlengine import semantic_analysis
+
+script = """
+    DS_A := DS_1 * 10;
+"""
+
+data_structures = {
+    'datasets': [
+        {'name': 'DS_1',
+         'DataStructure': [
+             {'name': 'Id_1',
+              'type':
+                  'Integer',
+              'role': 'Identifier',
+              'nullable': False},
+             {'name': 'Me_1',
+              'type': 'Number',
+              'role': 'Measure',
+              'nullable': True}
+         ]
+         }
+    ]
+}
+
+sa_result = semantic_analysis(script=script, data_structures=data_structures)
+
+print(sa_result)
+
+```
+
+Returns:
+
+```
+{'DS_A': Dataset(name='DS_A', components={'Id_1': Component(name='Id_1', data_type=<class 'vtlengine.DataTypes.Integer'>, role=<Role.IDENTIFIER: 'Identifier'>, nullable=False), 'Me_1': Component(name='Me_1', data_type=<class 'vtlengine.DataTypes.Number'>, role=<Role.MEASURE: 'Measure'>, nullable=True)}, data=None)}
+```
+
+#### Example 2: Incorrect VTL
+
+Note that, as compared to Example 1, the only change is that Me_1 is of the String data type,
+instead of Number.
+
+```python
+from vtlengine import semantic_analysis
+
+script = """
+    DS_A := DS_1 * 10;
+"""
+
+data_structures = {
+    'datasets': [
+        {'name': 'DS_1',
+         'DataStructure': [
+             {'name': 'Id_1',
+              'type':
+                  'Integer',
+              'role': 'Identifier',
+              'nullable': False},
+             {'name': 'Me_1',
+              'type': 'String',
+              'role': 'Measure',
+              'nullable': True}
+         ]
+         }
+    ]
+}
+
+sa_result = semantic_analysis(script=script, data_structures=data_structures)
+
+print(sa_result)
+
+```  
+
+Will raise the following Error:
+
+``` python
+raise SemanticError(code="1-1-1-2",
+vtlengine.Exceptions.SemanticError: ('Invalid implicit cast from String and Integer to Number.', '1-1-1-2')
+```
+
+### Run VTL Scripts
+
+The `run` method serves to execute a VTL script with input datapoints.
+
+Returns a dictionary with all the generated Datasets.
+When the output parameter is set, the engine will write the result of the computation to the output
+folder, else it will include the data in the dictionary of the computed datasets.
+
+Two validations are performed before running, which can raise errors:
+
+* Semantic analysis: Equivalent to running the `semantic_analysis` method
+* Data load analysis: Basic check of the data structure (names and types)
+
+#### Example 3: Simple run
+
+```python
+from vtlengine import run
+import pandas as pd
+
+script = """
+    DS_A := DS_1 * 10;
+"""
+
+data_structures = {
+    'datasets': [
+        {'name': 'DS_1',
+         'DataStructure': [
+             {'name': 'Id_1',
+              'type':
+                  'Integer',
+              'role': 'Identifier',
+              'nullable': False},
+             {'name': 'Me_1',
+              'type': 'Number',
+              'role': 'Measure',
+              'nullable': True}
+         ]
+         }
+    ]
+}
+
+data_df = pd.DataFrame(
+    {"Id_1": [1, 2, 3],
+     "Me_1": [10, 20, 30]})
+
+datapoints = {"DS_1": data_df}
+
+run_result = run(script=script, data_structures=data_structures,
+                 datapoints=datapoints)
+
+print(run_result)
+```
+
+returns:
+
+``` python
+{'DS_A': Dataset(name='DS_A', components={'Id_1': Component(name='Id_1', data_type=<class 'vtlengine.DataTypes.Integer'>, role=<Role.IDENTIFIER: 'Identifier'>, nullable=False), 'Me_1': Component(name='Me_1', data_type=<class 'vtlengine.DataTypes.Number'>, role=<Role.MEASURE: 'Measure'>, nullable=True)}, data=  Id_1   Me_1
+0    1  100.0
+1    2  200.0
+2    3  300.0)}
+```
+
+For more information on usage, please refer to
+the [API documentation](https://docs.vtlengine.meaningfuldata.eu/api.html).

vtlengine-1.0.1.dist-info/RECORD

@@ -0,0 +1,58 @@
+vtlengine/API/_InternalApi.py,sha256=emAbB-cOtThxcgYgFUmgQB_oxiBWSrAgSGOiqFKwlEo,14177
+vtlengine/API/__init__.py,sha256=gR3ZUmBJDOzPSO21b213u0xAR_OID7rzY0qs7oT04nc,10982
+vtlengine/AST/ASTConstructor.py,sha256=qmHkfiVmGGAYD7NeNJz_zyGxU3t0hY-kDdkzWjCyuVw,19976
+vtlengine/AST/ASTConstructorModules/Expr.py,sha256=hjPvuldphvIFM5wPTGHGRJESET24KwQGVuKHrnR6DPU,63190
+vtlengine/AST/ASTConstructorModules/ExprComponents.py,sha256=tH3GESt1UJ7zfGqHSzlkbtzNDUYQKeUL6E1rMhXE_cY,33779
+vtlengine/AST/ASTConstructorModules/Terminals.py,sha256=hcvgMzhWEAT1AsBZNrx80UYMf0nhcA4mbXDrcXAKQvc,25387
+vtlengine/AST/ASTConstructorModules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vtlengine/AST/ASTDataExchange.py,sha256=kPSz21DGbEv-2bZowObseqf2d2_iQj1VnrqWuD9ZwtA,140
+vtlengine/AST/ASTEncoders.py,sha256=0RxSQ-4SFTOhFtQFntNeo8VT_gq4qCi92ZK7EWWqOCM,758
+vtlengine/AST/ASTTemplate.py,sha256=_tpxlRoVTWK4YIODRUbxpZBzvYzLtt9Je47YsVmcyWQ,11923
+vtlengine/AST/ASTVisitor.py,sha256=3QQTudBpbR4pPQdH7y07EgwuzhoGzNQ59qox8R-E3fM,500
+vtlengine/AST/DAG/__init__.py,sha256=KAE0yz-kB6cBTJVBvOGcVT-fVStofDdCutjMsbITqNw,14714
+vtlengine/AST/DAG/_words.py,sha256=lEuBQ_w-KoKGna-x3gFGfbX1KP4Ez5EgdomH2LOeodk,170
+vtlengine/AST/Grammar/Vtl.g4,sha256=uxDPfJ14lMfxB5PyLf0f8Vb07T2z3JboU2FB22WMVz4,23776
+vtlengine/AST/Grammar/VtlTokens.g4,sha256=s4NtuaC9FcXNzUEAhy-HPQozfqSkoIaluHbzk9RKYkk,9570
+vtlengine/AST/Grammar/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vtlengine/AST/Grammar/lexer.py,sha256=MzmwQbpxXPb6AlVPIZrBxKVW7YuPGTbofM3aYN_AHbo,99945
+vtlengine/AST/Grammar/parser.py,sha256=3_3zhVGh7Pigt48efV_kv0fme3zifx8-6RW051u2DhY,562035
+vtlengine/AST/Grammar/tokens.py,sha256=BHXadghMsT3S8mSQANtaRXDdrlFk8988Qmu-dxlTERU,2884
+vtlengine/AST/VtlVisitor.py,sha256=BJMULkRXVxFEpyT3M6_t6vemVQIHeBIQlW-UuVkKbJE,35015
+vtlengine/AST/__init__.py,sha256=h-66EkZH5C08sBxYBa_n7BWLfQsTKgIkm6FQTbb54cY,9528
+vtlengine/DataTypes/NumericTypesHandling.py,sha256=eeSUhnRkAlcYjwbLZcuuUuJUNFWR3tVWQj8DfEHythk,1230
+vtlengine/DataTypes/TimeHandling.py,sha256=BE1axi7YkR0FRa6RyXxhMjTFFPaltYrdxA3eNGBkqNY,18783
+vtlengine/DataTypes/__init__.py,sha256=tAm7U383MWckZCCqoh2327XaU44qap_l8nGkmmQlh_o,21607
+vtlengine/Exceptions/__init__.py,sha256=pBn8yKbZfMtawJcso5Q0B-3vgFILxuLwB91tuYrTXwE,3507
+vtlengine/Exceptions/messages.py,sha256=pYS4s9ytHz0yMk6vtYEjgAs7r80c4NRIr5FMuQrN8A8,19850
+vtlengine/Interpreter/__init__.py,sha256=isF1NBPdhbjzyMx9cWF_WE2C7-TrKrUNMhLDwu8Cwcs,79725
+vtlengine/Model/__init__.py,sha256=4CT_kMfJOLdcRxQvvdzUxVxN1-J2LW1IIPjnewImL68,15486
+vtlengine/Operators/Aggregation.py,sha256=PyJqyOHfZ6o12w5FS-y9-5zfOdNmVjq1cXtn41rtD-E,11629
+vtlengine/Operators/Analytic.py,sha256=k0r1SPgSRH1tdJvG0X0suDdAxT2Wo23ZnnImpptXEO0,9993
+vtlengine/Operators/Assignment.py,sha256=xCL9OocHqXvfwMLm33aM8moRoZtgwNxd6OnmVVwbP0Q,795
+vtlengine/Operators/Boolean.py,sha256=9FFdmSlQLlR7cSXswQUlkD_WyFcQWqfGY5VtYwqpKb4,2890
+vtlengine/Operators/CastOperator.py,sha256=yPadG3PJ6h3G0TMvt1EOZWjEFilMmkvQsnKZLorzpys,16743
+vtlengine/Operators/Clause.py,sha256=GoE1CgXStq59MxbnIiMJfhPNsWtWZP7R4MTQaVzCPfA,14815
+vtlengine/Operators/Comparison.py,sha256=5Efnl4fCt0hWRn1iukkSOG7s6NWB9u3I5fEsGCVvkYw,16513
+vtlengine/Operators/Conditional.py,sha256=jCWXRJltdx6Tl4CWyK9HYZkcUeXeLEJHk-UX7y2vKoA,13067
+vtlengine/Operators/General.py,sha256=K6fxp-IbFTDGiZrm0A194bnQo7j0IcPyu5Y4Jq-91Hk,6652
+vtlengine/Operators/HROperators.py,sha256=jr6Wz-c9szhZ9luKAj3Bg1CwWbzauwlPOChzknvaBi0,8553
+vtlengine/Operators/Join.py,sha256=VwYCtzqlPT75iVctomp8NPAaKi3HiCQ1Pc_K7IPhZCU,18065
+vtlengine/Operators/Numeric.py,sha256=0dR_0HZymPk86jl0uD12HdFilS4xlMOlN9ffGELVElo,10801
+vtlengine/Operators/RoleSetter.py,sha256=vjFmZnKPONmR2ztBbi4om7DQZkK6t2joDxMg9v_JPBA,2247
+vtlengine/Operators/Set.py,sha256=7KnHUZaswz3TRcIeE1FwnI_TYR4LP4ZqbMN-bgPQU_g,7041
+vtlengine/Operators/String.py,sha256=hd9bVHqCAQVrXtBNN-oJlWZRONSfeVWRpIL654GvMr8,20315
+vtlengine/Operators/Time.py,sha256=5srrGi_QBSopJm2bfZAwokw94pnGjZngkMTJfBVNRUM,31815
+vtlengine/Operators/Validation.py,sha256=C7w1bvc8j-dYshPNvtpN_oCGMkbsoGoyv4WBCh9o2pg,10000
+vtlengine/Operators/__init__.py,sha256=CJEwWUlz827yp4lyuXPSsMCMd4IWqCOw0yYvqpB76CI,36993
+vtlengine/Utils/__init__.py,sha256=Plrr6nCPPUJ2PApbqsj0GAYF4Q7GBjLufv3-vCsJB6k,6458
+vtlengine/__init__.py,sha256=qmLklaVsS-yHG4QeSzGDYln49PLhFaIjBatYNwAm2Ug,89
+vtlengine/files/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vtlengine/files/output/__init__.py,sha256=X1gmR7Hwp1wKuVTEYPxJRg1cCH-9rYdJk5Ma4_iQc8o,1170
+vtlengine/files/output/_time_period_representation.py,sha256=3uSMK_tHXigsKNFt5-U75ZI9pIRVi6WERFwAG6jEBz0,1580
+vtlengine/files/parser/__init__.py,sha256=TT8MTquqppKxNXq0mgj0nA4jSN8ibufxaqxnofnUeqQ,8754
+vtlengine/files/parser/_rfc_dialect.py,sha256=Y8kAYBxH_t9AieN_tYg7QRh5A4DgvabKarx9Ko3QeCQ,462
+vtlengine/files/parser/_time_checking.py,sha256=SW89OWAnlTfzBYQDXk0GplImxZlN8XmvvGapJqQQ9Xs,4683
+vtlengine-1.0.1.dist-info/LICENSE.md,sha256=2xqHuoHohba7gpcZZKtOICRjzeKsQANXG8WoV9V35KM,33893
+vtlengine-1.0.1.dist-info/METADATA,sha256=aCPKAQRRY0okW85Lkw4Sx9MO1EAu_1pYJsg-dRVWVN0,7430
+vtlengine-1.0.1.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+vtlengine-1.0.1.dist-info/RECORD,,

{vtlengine-1.0.dist-info → vtlengine-1.0.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.0
+Generator: poetry-core 1.9.1
 Root-Is-Purelib: true
 Tag: py3-none-any

vtlengine-1.0.dist-info/METADATA

@@ -1,104 +0,0 @@
-Metadata-Version: 2.1
-Name: vtlengine
-Version: 1.0
-Summary: Run and Validate VTL Scripts
-License: AGPL-3.0
-Author: MeaningfulData
-Author-email: info@meaningfuldata.eu
-Requires-Python: >=3.10,<4.0
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: GNU Affero General Public License v3
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: antlr4-python3-runtime (==4.9.2)
-Requires-Dist: bottleneck (>=1.3.4,<2.0.0)
-Requires-Dist: duckdb (>=1.1.1,<2.0.0)
-Requires-Dist: networkx (>=2.8.8,<3.0.0)
-Requires-Dist: numba (>=0.60.0,<0.61.0)
-Requires-Dist: numexpr (>=2.9.0,<3.0.0)
-Requires-Dist: pandas (>=2.1.4,<3.0.0)
-Requires-Dist: pyarrow (>=17.0.0,<18.0.0)
-Requires-Dist: s3fs (>=2024.9.0,<2025.0.0)
-Requires-Dist: sqlglot (>=22.2.0,<23.0.0)
-Description-Content-Type: text/markdown
-
-# VTL Engine
-
-## Introduction
-
-The VTL Engine is a Python library that allows you to validate and run VTL scripts.
-It is a Python-based library around the [VTL Language](http://sdmx.org/?page_id=5096).
-
-## Installation
-
-### Requirements
-
-The VTL Engine requires Python 3.10 or higher.
-
-### Install with pip
-To install the VTL Engine on any Operating System, you can use pip:
-
-```bash
-pip install vtlengine
-```
-
-*Note: it is recommended to install the VTL Engine in a virtual environment.* 
-
-
-## Usage
-
-### Semantic Analysis
-To perform the validation of a VTL script, please use the semantic_analysis function. 
-Here is an example:
-
-```python
-
-from API import semantic_analysis
-from pathlib import Path
-
-base_path = Path(__file__).parent / "testSuite/API/data/"
-script = base_path / Path("vtl/1.vtl")
-datastructures = base_path / Path("DataStructure/input")
-value_domains = base_path / Path("ValueDomain/VD_1.json")
-external_routines = base_path / Path("sql/1.sql")
-
-semantic_analysis(script=script, data_structures=datastructures, 
-                  value_domains=value_domains, external_routines=external_routines)
-```
-
-The semantic analysis function will return a dictionary of the computed datasets and their structure.
-
-### Run VTL Scripts
-
-To execute a VTL script, please use the run function. Here is an example:
-
-```python
-
-from API import run
-from pathlib import Path
-
-base_path = Path(__file__).parent / "testSuite/API/data/"
-script = base_path / Path("vtl/1.vtl")
-datastructures = base_path / Path("DataStructure/input")
-datapoints = base_path / Path("DataSet/input")
-output_folder = base_path / Path("DataSet/output")
-
-value_domains = None
-external_routines = None
-
-run(script=script, data_structures=datastructures, datapoints=datapoints,
-    value_domains=value_domains, external_routines=external_routines,
-    output_path=output_folder, return_only_persistent=True
-    )
-```
-The VTL engine will load each datapoints file as being needed, reducing the memory footprint.
-When the output parameter is set, the engine will write the result of the computation 
-to the output folder, else it will include the data in the dictionary of the computed datasets.
-
-For more information on usage, please refer to the [API documentation](https://docs.vtlengine.meaningfuldata.eu/api.html).
-

vtlengine-1.0.dist-info/RECORD

@@ -1,58 +0,0 @@
-vtlengine/API/_InternalApi.py,sha256=dYR42DbyY_umGfRXQOiz_-wGB9_jcx9Q3ooiWo--hbg,12526
-vtlengine/API/__init__.py,sha256=2uknCsuffQ8Mj01ETYW2esM0nhZyw_Qu2Vu5IOxuaec,10168
-vtlengine/AST/ASTConstructor.py,sha256=UyW_0lraVH8RZ2MmAfHt445nqDY1woc0GKEyUht4bSQ,19406
-vtlengine/AST/ASTConstructorModules/Expr.py,sha256=GdRbg1erybHIZEKDL26jErxjKB7_0meGZKXrUCBHHNA,62808
-vtlengine/AST/ASTConstructorModules/ExprComponents.py,sha256=8tVFR-gLDnqJV1lCrGf0-YH-KqydVHfzCVmya6c1-Tk,33581
-vtlengine/AST/ASTConstructorModules/Terminals.py,sha256=AC81AaQnM47EZtK40R9XexLqZCrJAmYd_aodwxQ5NXU,24889
-vtlengine/AST/ASTConstructorModules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vtlengine/AST/ASTDataExchange.py,sha256=kPSz21DGbEv-2bZowObseqf2d2_iQj1VnrqWuD9ZwtA,140
-vtlengine/AST/ASTEncoders.py,sha256=a_NhyUfUEVfSFyArb-nXIM2wvQZX96OBloJy1hGF12Q,758
-vtlengine/AST/ASTTemplate.py,sha256=h61kxO_yfvDO3LnEhSavvN3eV8sAyffRV85GEKu-brc,11942
-vtlengine/AST/ASTVisitor.py,sha256=ovGXIfdCcY8ukUE5hiPbdxmAPPdHOzcS-dL-CsgwEDY,494
-vtlengine/AST/DAG/__init__.py,sha256=ErxDIxBY6W8d9Ed9J1fYS8Jmlv6c0RX_B0Ktt6Su8yo,14709
-vtlengine/AST/DAG/_words.py,sha256=b7Mgp4dL1Wd4uMDdtEmF_esxn2GR8C3mqEKO9ysuhrg,170
-vtlengine/AST/Grammar/Vtl.g4,sha256=uxDPfJ14lMfxB5PyLf0f8Vb07T2z3JboU2FB22WMVz4,23776
-vtlengine/AST/Grammar/VtlTokens.g4,sha256=s4NtuaC9FcXNzUEAhy-HPQozfqSkoIaluHbzk9RKYkk,9570
-vtlengine/AST/Grammar/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vtlengine/AST/Grammar/lexer.py,sha256=2_nnGDCc6P2i0VDVfKI0Db61PWYBEuylVs50ph5F1CM,96642
-vtlengine/AST/Grammar/parser.py,sha256=kU7FYalgvS4IiEETlmqje4kd8BawJsrCGiPiEc6j9Zw,545780
-vtlengine/AST/Grammar/tokens.py,sha256=Dq4OD3kYyc6EH4wQ0JoC04KHn2gazoVEgzl7__Jrqpg,2884
-vtlengine/AST/VtlVisitor.py,sha256=t59fHL-gYjZSIRgE2h9R8aVLA2CVHSJ3WbHIddswX_U,35077
-vtlengine/AST/__init__.py,sha256=GmUtsS8J9-4k1MZifQg1ZgM_0iJaA-39h99nh4Hhiyk,9516
-vtlengine/DataTypes/NumericTypesHandling.py,sha256=CuQtCFHKS1voMwjk-jHZM4hD2XN4l1wJxeD3e-bGHaQ,1017
-vtlengine/DataTypes/TimeHandling.py,sha256=irH2wHU4luB0dVdTh-5id-rgoNlW-WnBdkH1-gbc7vM,20478
-vtlengine/DataTypes/__init__.py,sha256=QkkPZRzxTXGhI_GV3gFErGlNYeoDUv3qBSYxv8XnMe8,20762
-vtlengine/Exceptions/__init__.py,sha256=WBRLEjb0lIRO1oeqUg245MZj_fFNMsq6leZvq66lyaM,2851
-vtlengine/Exceptions/messages.py,sha256=LSERRfUOgXsPwVkd_1L6tJGL6AFvtuZ6MqOhb4J09uw,18655
-vtlengine/Interpreter/__init__.py,sha256=UK4btF5D4hJtOgXgeN7YVgiZfOFIJG0hAlX44wNqqFw,73817
-vtlengine/Model/__init__.py,sha256=NHVWPqlw3CuGjujo5hfsKez2Vf1EmtuRzxSiQ1w0oNQ,14778
-vtlengine/Operators/Aggregation.py,sha256=3COPPQT2I4Is_Dz5kwgmLn88Oine0FeN_dRH-LSZ70A,11166
-vtlengine/Operators/Analytic.py,sha256=Y4wI14Bclxd2CpI45UF16QbvowfUJcgva0dcBz3JoRY,9658
-vtlengine/Operators/Assignment.py,sha256=JA8TtcwhKNwLIEIitzEM3PTUy700Ls8iZ7tDXVQIxbo,768
-vtlengine/Operators/Boolean.py,sha256=itItNmFuZg9iVPpTYIQJ3xCZ83WYq5QQKT_keKb1h3Y,2973
-vtlengine/Operators/CastOperator.py,sha256=3JlzQNHDPkMimffV34QEdwE1p0YJgsAQoP36xfboYJI,16611
-vtlengine/Operators/Clause.py,sha256=hPPV0oZ1V_ExR-hLV1WJyvrbOERy22BLFizd7sd_gZc,13748
-vtlengine/Operators/Comparison.py,sha256=WRllEMPZyaSMMm8-4s8muWeZ3QLc9qC9Xs1X1ibSLRM,16522
-vtlengine/Operators/Conditional.py,sha256=g7dON5TWxO6yOMhCa_EgfYE5bHqlfjof7PEFBqVcp7E,12417
-vtlengine/Operators/General.py,sha256=hf9a3Vjq_S1z5Fj3Q3lykXzwmsLKlJ1Mkg7M74df9kA,6546
-vtlengine/Operators/HROperators.py,sha256=6k8rya5bkxR09sZm_vI9GIDWjYCZi05P_6nAzC404YE,8614
-vtlengine/Operators/Join.py,sha256=o1MRZ5sMiujstQrAYS57BE_SnW__6ogIVJD1LC6CKzA,15570
-vtlengine/Operators/Numeric.py,sha256=Sk2eXmHmnL1NPZK0UvSUMTKNYGt0anXImCor1DbH3Go,10292
-vtlengine/Operators/RoleSetter.py,sha256=MQQBkpfJAQ5mTvAET5hs21kxoESof_aTQNSUzvRMgcg,2075
-vtlengine/Operators/Set.py,sha256=14-QmJ6jM-asCf-of0zxmK-sXhMUB11N_7NCH2p6nvU,6343
-vtlengine/Operators/String.py,sha256=5Urz2t7bPeMXxtvA-p_WCZKhdTpk1rWl3yboNOscQI8,20069
-vtlengine/Operators/Time.py,sha256=2TXhkrZDdQFNOX-2juLNZhlgu0eDCmmDavqN41kAZ9U,29708
-vtlengine/Operators/Validation.py,sha256=0Fxxbf2SUHHOSBuqjsY6seSIuf7RPvED3RlzCCcoxHs,10052
-vtlengine/Operators/__init__.py,sha256=AhsShQhr0wblRXpDTAk_DYj6RUF8wKC_71DY7mav9eA,36387
-vtlengine/Utils/__init__.py,sha256=ePVlQjwmAyPfdiLx2zjfttHXcpYdVVxOOJfqmTVLDug,5427
-vtlengine/__init__.py,sha256=yQTWCUMo6A1ym0Gz8hTDzY8e9-2HIEkWT_dZsmEQscI,88
-vtlengine/files/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-vtlengine/files/output/__init__.py,sha256=AJjDcpHJOqqQTTFVlKkhKnaDqLD6ujfnVO7amViKavk,1045
-vtlengine/files/output/_time_period_representation.py,sha256=6jIRRjd900aay7ZtKe7S02gwV51K7_8SrIO8qW9kn4w,1579
-vtlengine/files/parser/__init__.py,sha256=6OIgKXQ_r4lnm6Ch2THmcUGRwywxyAdgUZmpxdfR3IQ,8492
-vtlengine/files/parser/_rfc_dialect.py,sha256=FGAMgp5GhovpIU-cMa1Nmwz2kbcIQPym7tmgxWzDUfk,455
-vtlengine/files/parser/_time_checking.py,sha256=zhq0tWAj7IFp1FdwxfFLlJ-W69VbbnUNO4slZTIC2HM,4735
-vtlengine-1.0.dist-info/LICENSE.md,sha256=2xqHuoHohba7gpcZZKtOICRjzeKsQANXG8WoV9V35KM,33893
-vtlengine-1.0.dist-info/METADATA,sha256=Ql6Lr12GZmtbE86ytN81UG2yE00iEn6vh_xEZEswkU0,3416
-vtlengine-1.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-vtlengine-1.0.dist-info/RECORD,,