# HESTIA Data Validation
[![Pipeline Status](https://gitlab.com/hestia-earth/hestia-data-validation/badges/master/pipeline.svg)](https://gitlab.com/hestia-earth/hestia-data-validation/commits/master)
[![Coverage Report](https://gitlab.com/hestia-earth/hestia-data-validation/badges/master/coverage.svg)](https://gitlab.com/hestia-earth/hestia-data-validation/commits/master)
[![Documentation Status](https://readthedocs.org/projects/hestia-data-validation/badge/?version=latest)](https://hestia-data-validation.readthedocs.io/en/latest/?badge=latest)
## Install
```bash
pip install hestia_earth_validation
```
## Usage
```python
from hestia_earth.validation import validate
# for each node, this will return a list containing all the errors/warnings (empty list if no errors/warnings)
errors = validate(nodes)
```
Note 1: if you want to validate existing data (with `@type` and `@id` fields), please set the following environment variable:
```
VALIDATE_EXISTING_NODES=true
```
Note 2: to skip searching for terms using the HESTIA API, please enable mocking:
```
ENABLE_MOCKING=true
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/hestia-earth/hestia-data-validation",
"name": "hestia-earth-validation",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "hestia, data, validation",
"author": "Guillaume Royer",
"author_email": "guillaumeroyer.mail@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/60/a9/33842fc214c66bc0db39331de276d26ea5d00c7c33937dbbdb7776622c07/hestia_earth_validation-0.32.19.tar.gz",
"platform": null,
"description": "# HESTIA Data Validation\n\n[![Pipeline Status](https://gitlab.com/hestia-earth/hestia-data-validation/badges/master/pipeline.svg)](https://gitlab.com/hestia-earth/hestia-data-validation/commits/master)\n[![Coverage Report](https://gitlab.com/hestia-earth/hestia-data-validation/badges/master/coverage.svg)](https://gitlab.com/hestia-earth/hestia-data-validation/commits/master)\n[![Documentation Status](https://readthedocs.org/projects/hestia-data-validation/badge/?version=latest)](https://hestia-data-validation.readthedocs.io/en/latest/?badge=latest)\n\n## Install\n\n```bash\npip install hestia_earth_validation\n```\n\n## Usage\n\n```python\nfrom hestia_earth.validation import validate\n\n# for each node, this will return a list containing all the errors/warnings (empty list if no errors/warnings)\nerrors = validate(nodes)\n```\n\nNote 1: if you want to validate existing data (with `@type` and `@id` fields), please set the following environment variable:\n\n```\nVALIDATE_EXISTING_NODES=true\n```\n\nNote 2: to skip searching for terms using the HESTIA API, please enable mocking:\n\n```\nENABLE_MOCKING=true\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "HESTIA Data Validation library",
"version": "0.32.19",
"project_urls": {
"Homepage": "https://gitlab.com/hestia-earth/hestia-data-validation"
},
"split_keywords": [
"hestia",
" data",
" validation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b625ce3d062048b061717b1c5410b3c5589a3b993cbd0f32909f1d65c2ef2dcf",
"md5": "994165f2771807f80e175adb4c6daec2",
"sha256": "ab25037493091206b691d4b4d0bdd7238f3b3a2ae65244f1fa72e364b29006b1"
},
"downloads": -1,
"filename": "hestia_earth_validation-0.32.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "994165f2771807f80e175adb4c6daec2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 82762,
"upload_time": "2025-01-23T13:35:34",
"upload_time_iso_8601": "2025-01-23T13:35:34.793052Z",
"url": "https://files.pythonhosted.org/packages/b6/25/ce3d062048b061717b1c5410b3c5589a3b993cbd0f32909f1d65c2ef2dcf/hestia_earth_validation-0.32.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "60a933842fc214c66bc0db39331de276d26ea5d00c7c33937dbbdb7776622c07",
"md5": "a549fb2a11d39fd722618f2c48054280",
"sha256": "4e1ca5a40eba9078eec29263a45451d55bf0ef63a7b38c15d8233026076c0773"
},
"downloads": -1,
"filename": "hestia_earth_validation-0.32.19.tar.gz",
"has_sig": false,
"md5_digest": "a549fb2a11d39fd722618f2c48054280",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 59255,
"upload_time": "2025-01-23T13:35:36",
"upload_time_iso_8601": "2025-01-23T13:35:36.824324Z",
"url": "https://files.pythonhosted.org/packages/60/a9/33842fc214c66bc0db39331de276d26ea5d00c7c33937dbbdb7776622c07/hestia_earth_validation-0.32.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 13:35:36",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "hestia-earth",
"gitlab_project": "hestia-data-validation",
"lcname": "hestia-earth-validation"
}