excel-validator 0.0.1__tar.gz

excel_validator-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 EU H2020 AGENT project
+
+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.

excel_validator-0.0.1/MANIFEST.in

@@ -0,0 +1 @@
+prune src/excel_validator/config/agent

excel_validator-0.0.1/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: excel-validator
+Version: 0.0.1
+Summary: Validation of template based Excel files
+Author-email: Matthijs Brouwer <matthijs.brouwer@wur.nl>
+License: MIT License
+        
+        Copyright (c) 2024 EU H2020 AGENT project
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/matthijsbrouwer/excel-validator
+Classifier: Topic :: Internet :: Proxy Servers
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: frictionless>=5.17.0
+Requires-Dist: jsonschema>=4.22.0
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: openpyxl>=3.1.2
+Requires-Dist: pandas>=2.2.2
+Requires-Dist: rich>=13.7.1
+Requires-Dist: tqdm>=4.66.4
+
+# Excel Validator
+
+Excel Validator is a Python package designed to validate Excel files (.xlsx) based on configured schemas. The tool ensures your Excel files adhere to specified schemas and generates detailed reports in case of validation errors. Built on the robust Frictionless library, Excel Validator also allows for dynamic schema creation, where fields are included based on row data from other sheets.
+
+## Features
+
+* Validate Excel files against predefined schemas.
+* Generate detailed reports highlighting any validation issues.
+* Dynamic schema creation based on data from other sheets.
+* Easy integration with your existing data processing workflows.
+* Built on top of the Frictionless library for reliable and extensible validation.
+
+## Installation
+
+You can install Excel Validator via pip:
+
+```
+pip install excel-validator
+```
+
+
+---
+This software has been developed for the [AGENT](https://www.agent-project.eu/) project
+

excel_validator-0.0.1/README.md

@@ -0,0 +1,24 @@
+# Excel Validator
+
+Excel Validator is a Python package designed to validate Excel files (.xlsx) based on configured schemas. The tool ensures your Excel files adhere to specified schemas and generates detailed reports in case of validation errors. Built on the robust Frictionless library, Excel Validator also allows for dynamic schema creation, where fields are included based on row data from other sheets.
+
+## Features
+
+* Validate Excel files against predefined schemas.
+* Generate detailed reports highlighting any validation issues.
+* Dynamic schema creation based on data from other sheets.
+* Easy integration with your existing data processing workflows.
+* Built on top of the Frictionless library for reliable and extensible validation.
+
+## Installation
+
+You can install Excel Validator via pip:
+
+```
+pip install excel-validator
+```
+
+
+---
+This software has been developed for the [AGENT](https://www.agent-project.eu/) project
+

excel_validator-0.0.1/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "excel-validator"
+authors = [
+  { name="Matthijs Brouwer", email="matthijs.brouwer@wur.nl" },
+]
+description = "Validation of template based Excel files"
+readme = "README.md"
+license = {file = "LICENSE"}
+requires-python = ">=3.11"
+dynamic = ["dependencies","version"]
+classifiers = [
+    "Topic :: Internet :: Proxy Servers",
+    "Topic :: Scientific/Engineering :: Bio-Informatics",
+    "Programming Language :: Python :: 3.11",
+    "Operating System :: OS Independent"
+]
+
+[project.urls]
+Homepage = "https://github.com/matthijsbrouwer/excel-validator"
+
+[project.scripts]
+excel_validator = "excel_validator.script.service:service"
+
+[build-system]
+requires = [
+    "read_version[toml] ~= 0.3.0",
+    "setuptools >= 42.0.0",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.package-data]
+excel_validator = ["**/*.json"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
+[tool.read_version]
+version = "src.excel_validator._version:__version__"
+

excel_validator-0.0.1/requirements.txt

@@ -0,0 +1,7 @@
+frictionless>=5.17.0
+jsonschema>=4.22.0
+numpy>=1.26.4
+openpyxl>=3.1.2
+pandas>=2.2.2
+rich>=13.7.1
+tqdm>=4.66.4

excel_validator-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

excel_validator-0.0.1/src/excel_validator/__init__.py

@@ -0,0 +1,5 @@
+from ._version import __version__
+from .validator import Validate
+from .module import AbstractValidationModule
+
+__author__ = "Matthijs Brouwer"

excel_validator-0.0.1/src/excel_validator/_version.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"

excel_validator-0.0.1/src/excel_validator/config/default/config.json

@@ -0,0 +1,7 @@
+{
+    "settings": {
+        "allowAdditionalSheets": true,
+        "schemaPath": "schema"
+    },
+    "sheets":[]
+}

excel_validator-0.0.1/src/excel_validator/config.json

@@ -0,0 +1,291 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",  
+    "$id": "https://www.plantbreeding.wur.nl/xlsx-validator/configuration.schema.json",  
+    "title": "Configuration xlsx-validator",  
+    "description": "A configuration file for the xlsx-validator package",
+    "type": "object",
+    "properties": {
+        "settings": {
+            "type": "object",
+            "description": "General settings",
+            "properties": {
+                "allowAdditionalSheets": {
+                    "type": "boolean", 
+                    "description": "Allow presence of additional sheets",
+                    "default": false
+                },
+                "requireSheetOrder": {
+                    "type": "boolean", 
+                    "description": "Require the sheets to be in the defined order", 
+                    "default": false
+                },
+                "adjustTypeForStringColumns": {
+                    "type": "boolean", 
+                    "description": "Automatically adjust type for string columns", 
+                    "default": false
+                },
+                "removeEmptyRows": {
+                    "type": "boolean", 
+                    "description": "Automatically remove empty rows", 
+                    "default": false
+                },
+                "removeEmptyColumns": {
+                    "type": "boolean", 
+                    "description": "Automatically remove empty columns", 
+                    "default": false
+                },
+                "schemaPath": {
+                    "type": "string", 
+                    "description": "Location additional modules", 
+                    "default": false
+                },
+                "modulesPath": {
+                    "type": "string", 
+                    "description": "Location additional modules", 
+                    "default": false
+                }
+            },
+            "additionalProperties": false
+        },
+        "sheets": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "name": {"type": "string", "description": "Name of the sheet"},
+                    "optional": {"type": "boolean"},
+                    "dependencies": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "resource": {
+                        "type": "string", 
+                        "description": "Name of the resource; can only contain lowercase alphanumeric characters plus ., - and _", 
+                        "pattern": "^[a-z0-9][a-z0-9\\.,\\-_]*$"},
+                    "adjustTypeForStringColumns": {
+                        "type": "boolean", 
+                        "description": "Automatically adjust type for string columns, does override settings"
+                    },
+                    "removeEmptyRows": {
+                        "type": "boolean", 
+                        "description": "Automatically remove empty rows, does override settings"
+                    },
+                    "removeEmptyColumns": {
+                        "type": "boolean", 
+                        "description": "Automatically remove empty columns, does override settings"
+                    },
+                    "schema": {
+                        "type": "object",
+                        "properties": {
+                            "file": {"type": "string"},
+                            "data": {"type": "object"},
+                            "dynamic": {
+                                "type": "array",
+                                "items": {
+                                    "type": "object",
+                                    "properties": {
+                                        "position": {"type": "string", "enum": ["before","after"]},
+                                        "field": {"type": "string"},
+                                        "dynamicResources": {
+                                            "type": "object",
+                                            "additionalProperties": {
+                                                "type": "object",
+                                                "properties": {
+                                                    "resource": {"type": "string"},
+                                                    "condition": {"$ref": "#/$defs/conditionResource"}
+                                                },
+                                                "required": ["resource"],
+                                                "additionalProperties": false
+                                            }
+                                        },
+                                        "linkedResources": {
+                                            "type": "object",
+                                            "additionalProperties": {
+                                                "type": "object",
+                                                "properties": {
+                                                    "resource": {"type": "string"},
+                                                    "condition": {"$ref": "#/$defs/conditionLinkedResource"}
+                                                },
+                                                "required": ["resource"],
+                                                "additionalProperties": false
+                                            }
+                                        },
+                                        "mappings": {
+                                            "type": "object",
+                                            "additionalProperties": {
+                                                "type": "object",
+                                                "properties": {
+                                                    "default": {"type": "string"},
+                                                    "map": {
+                                                        "type": "object",
+                                                        "additionalProperties": {"$ref": "#/$defs/anyValue"}
+                                                    }
+                                                },
+                                                "required": ["map"],
+                                                "additionalProperties": false
+                                            }
+                                        },                                        
+                                        "fields": {
+                                            "type": "array",
+                                            "items": {
+                                                "type": "object",
+                                                "patternProperties": {
+                                                    "name|type|rdfType|title|format|example|description": {"oneOf": [
+                                                        {"type": "string"},
+                                                        {"$ref": "#/$defs/fieldProperty"}
+                                                    ]}
+                                                },
+                                                "properties": {
+                                                    "constraints": {
+                                                        "type": "object",
+                                                        "patternProperties": {
+                                                            "required|unique": {"oneOf": [
+                                                                {"type": "boolean"},
+                                                                {"$ref": "#/$defs/fieldProperty"}]
+                                                            },
+                                                            "minLength|maxLength": {"oneOf": [
+                                                                {"type": "integer"},
+                                                                {"$ref": "#/$defs/fieldProperty"}
+                                                            ]},
+                                                            "minimum|maximum": {"oneOf": [
+                                                                {"type": "number"},
+                                                                {"$ref": "#/$defs/fieldProperty"}
+                                                            ]},
+                                                            "pattern": {"oneOf": [
+                                                                {"type": "string"},
+                                                                {"$ref": "#/$defs/fieldProperty"}
+                                                            ]},
+                                                            "enum": {"oneOf": [
+                                                                {"type": "array", "items": {"$ref": "#/$defs/anyValue"}},
+                                                                {"$ref": "#/$defs/fieldProperty"}
+                                                            ]}
+                                                        },
+                                                        "additionalProperties": false
+                                                    }
+                                                },
+                                                "required": ["name"],
+                                                "additionalProperties": false
+                                            }
+                                        }
+                                    },
+                                    "required": ["position","fields"],
+                                    "additionalProperties": false
+                                }
+                            }
+                        },
+                        "oneOf": [
+                            {"required": ["file"], "not": {"required": ["data"]}},
+                            {"required": ["data"], "not": {"required": ["file"]}}
+                        ],
+                        "additionalProperties": false
+                    },
+                    "checklist": {
+                        "type": "object",
+                        "properties": {
+                            "file": {"type": "string"},
+                            "data": {"type": "object"}
+                        },
+                        "oneOf": [
+                            {"required": ["file"], "not": {"required": ["data"]}},
+                            {"required": ["data"], "not": {"required": ["file"]}}
+                        ],
+                        "additionalProperties": false
+                    },
+                    "modules": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "name": {"type": "string", "description": "Name of the module"},
+                                "config": {"type": "object", "description": "Configuration"}
+                            }
+                        },
+                        "required": ["name"],
+                        "additionalProperties": false
+                    }
+                },
+                "required": ["name"],
+                "additionalProperties": false
+            }
+        }
+    },
+    "required": ["settings","sheets"],
+    "additionalProperties": false,
+    "$defs": {
+        "anyValue": {
+            "type": ["string","number"]
+        },
+        "conditionResource": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "field": {"type": "string"},
+                    "value": {"$ref": "#/$defs/anyValue"}
+                }
+            },
+            "required": ["field","value"]
+        },
+        "conditionLinkedResource": {
+            "type": "array",
+            "description": "condition on linkedResource based on value or dynamicResource",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "field": {"type": "string"},
+                    "value": {
+                        "oneOf": [
+                            {"$ref": "#/$defs/anyValue"},
+                            {
+                                "type": "object",
+                                "properties": {
+                                    "field": {"type": "string"},
+                                    "dynamicResource": {"type": "string"}
+                                },
+                                "required": ["field","dynamicResource"],
+                                "additionalProperties": false
+                            }
+                        ]
+                    }
+                }
+            },
+            "required": ["field","value"]
+        },
+        "conditionFieldProperty": {
+            "type": "array",
+            "description": "condition on dynamicResource to be satisfied to add field property",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "dynamicResource": {"type": "string"},
+                    "field": {"type": "string"},
+                    "value": {"oneOf": [
+                        {"type": "array", "items": {"$ref": "#/$defs/anyValue"}},
+                        {"$ref": "#/$defs/anyValue"}
+                    ]}
+                }
+            },
+            "required": ["dynamicResource","field","value"]
+        },
+        "fieldProperty": {
+            "type": "object",
+            "description": "field property with value generated from linkedResource or dynamicResource",
+            "properties": {
+                "field": {"type": "string"}, 
+                "linkedResource": {"type": "string"},
+                "dynamicResource": {"type": "string"},
+                "condition": {"$ref": "#/$defs/conditionFieldProperty"},
+                "mapping": {"type": "string"},
+                "prefix": {"type": "string"},
+                "postfix": {"type": "string"}
+            },
+            "oneOf": [
+                {"required": ["field","linkedResource"], "not": {"required": ["dynamicResource"]}},
+                {"required": ["field","dynamicResource"], "not": {"required": ["linkedResource"]}}
+            ],
+            "additionalProperties": false
+        }
+    }
+}