# ogc-na-tools
## TL;DR
You can install the tools with `pip`:
```shell
pip install ogc-na
```
## Purpose
This repository contains tools used to maintain controlled vocabularies and knowledge assets managed by the OGC Naming Authority. Such tools may have wider general applicability and be refactored into tool specific repositories.
## Scope
The tools here manage ETL processes for ingesting source data into a dynamic knowledge graph. Whilst this is quite a generic scope, this provides examples of how to use a range of resources that others may reuse to achieve similar results.
## Highlights
* JSON ingest and conversion to RDF using semantic annotations and conversions to a target model schema.
* entailment and validation pipeline for RDF resources.
* specific scripts to convert OGC source material into a form compatible with the OGC Linked Data environment
* tutorial for docker deployment and testing of available tools.
## Documentation and tools
The full documentation can be found [here](https://opengeospatial.github.io/ogc-na-tools/).
The following tools are currently available:
* `ingest_json`: Performs JSON-to-JSON-LD semantic uplifts [(read more)](https://opengeospatial.github.io/ogc-na-tools/reference/ogc/na/ingest_json/)
* `update_vocabs`: Allows defining RDF entailment + validation + upload pipelines [(read more)](https://opengeospatial.github.io/ogc-na-tools/reference/ogc/na/update_vocabs/)
* `annotate_schema`: Annotates JSON schemas by leveraging `@modelReference` links to JSON-LD contexts [(read more)](https://opengeospatial.github.io/ogc-na-tools/reference/ogc/na/annotate_schema/)
## Development
Note: This is only necessary if you are going to work *on* the tools themselves, not *with* them (see [TL;DR](#tldr)
above).
To install runtime and development dependencies, run:
```shell
pip install -e .[dev]
```
### Building the documentation
`mkdocs` is used for generating documentation pages.
* To build the documentation (will be written to the `site/` directory): `mkdocs build`
* To deploy to GitHub pages: `mkdocs gh-deploy`
Raw data
{
"_id": null,
"home_page": null,
"name": "ogc-na",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "ogc, ogc-na, naming authority, ogc rainbow, definitions server",
"author": null,
"author_email": "Rob Atkinson <ratkinson@ogc.org>, Piotr Zaborowski <pzaborowski@ogc.org>, Alejandro Villar <avillar@ogc.org>",
"download_url": "https://files.pythonhosted.org/packages/3c/da/0ebb85c40a4818228d76cd0a3c367a824999a31c288f817f99402f2a9e9a/ogc_na-0.3.55.tar.gz",
"platform": null,
"description": "# ogc-na-tools\n\n## TL;DR\n\nYou can install the tools with `pip`:\n\n```shell\npip install ogc-na\n```\n\n## Purpose\nThis repository contains tools used to maintain controlled vocabularies and knowledge assets managed by the OGC Naming Authority. Such tools may have wider general applicability and be refactored into tool specific repositories.\n\n## Scope\nThe tools here manage ETL processes for ingesting source data into a dynamic knowledge graph. Whilst this is quite a generic scope, this provides examples of how to use a range of resources that others may reuse to achieve similar results.\n\n## Highlights\n\n* JSON ingest and conversion to RDF using semantic annotations and conversions to a target model schema.\n* entailment and validation pipeline for RDF resources.\n* specific scripts to convert OGC source material into a form compatible with the OGC Linked Data environment\n* tutorial for docker deployment and testing of available tools.\n\n## Documentation and tools\n\nThe full documentation can be found [here](https://opengeospatial.github.io/ogc-na-tools/).\n\nThe following tools are currently available:\n\n* `ingest_json`: Performs JSON-to-JSON-LD semantic uplifts [(read more)](https://opengeospatial.github.io/ogc-na-tools/reference/ogc/na/ingest_json/) \n* `update_vocabs`: Allows defining RDF entailment + validation + upload pipelines [(read more)](https://opengeospatial.github.io/ogc-na-tools/reference/ogc/na/update_vocabs/)\n* `annotate_schema`: Annotates JSON schemas by leveraging `@modelReference` links to JSON-LD contexts [(read more)](https://opengeospatial.github.io/ogc-na-tools/reference/ogc/na/annotate_schema/)\n\n## Development\n\nNote: This is only necessary if you are going to work *on* the tools themselves, not *with* them (see [TL;DR](#tldr)\nabove). \n\nTo install runtime and development dependencies, run:\n\n```shell\npip install -e .[dev]\n```\n\n### Building the documentation\n\n`mkdocs` is used for generating documentation pages.\n\n* To build the documentation (will be written to the `site/` directory): `mkdocs build`\n* To deploy to GitHub pages: `mkdocs gh-deploy`\n",
"bugtrack_url": null,
"license": null,
"summary": "OGC Naming Authority tools",
"version": "0.3.55",
"project_urls": {
"Documentation": "https://opengeospatial.github.io/ogc-na-tools/",
"Homepage": "https://github.com/opengeospatial/ogc-na-tools/",
"Repository": "https://github.com/opengeospatial/ogc-na-tools.git"
},
"split_keywords": [
"ogc",
" ogc-na",
" naming authority",
" ogc rainbow",
" definitions server"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55812cdb84425208174e9354367d952de53a2e59ee8fc6d3517be19aa43230bd",
"md5": "13241e86f69477b1cc5a4142a6fe3b4a",
"sha256": "a84b80b9536d73ecb436439d642a4347c7f9b71b58fc82feca52cac18f072250"
},
"downloads": -1,
"filename": "ogc_na-0.3.55-py3-none-any.whl",
"has_sig": false,
"md5_digest": "13241e86f69477b1cc5a4142a6fe3b4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 49543,
"upload_time": "2024-10-30T11:36:40",
"upload_time_iso_8601": "2024-10-30T11:36:40.330533Z",
"url": "https://files.pythonhosted.org/packages/55/81/2cdb84425208174e9354367d952de53a2e59ee8fc6d3517be19aa43230bd/ogc_na-0.3.55-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3cda0ebb85c40a4818228d76cd0a3c367a824999a31c288f817f99402f2a9e9a",
"md5": "da27537a94e2392674bea06d38ef0e37",
"sha256": "21f1ccdf957bd8808698eaedae7b58e1973cfc086e78f42c52e77ca334388f97"
},
"downloads": -1,
"filename": "ogc_na-0.3.55.tar.gz",
"has_sig": false,
"md5_digest": "da27537a94e2392674bea06d38ef0e37",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 60343,
"upload_time": "2024-10-30T11:36:41",
"upload_time_iso_8601": "2024-10-30T11:36:41.819394Z",
"url": "https://files.pythonhosted.org/packages/3c/da/0ebb85c40a4818228d76cd0a3c367a824999a31c288f817f99402f2a9e9a/ogc_na-0.3.55.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 11:36:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opengeospatial",
"github_project": "ogc-na-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pyshacl",
"specs": [
[
">=",
"0.19"
]
]
},
{
"name": "rdflib",
"specs": [
[
">=",
"6.3.0"
]
]
},
{
"name": "html5lib",
"specs": []
},
{
"name": "jq",
"specs": []
},
{
"name": "jsonpath-ng",
"specs": []
},
{
"name": "PyYAML",
"specs": []
},
{
"name": "wcmatch",
"specs": []
},
{
"name": "requests",
"specs": [
[
">=",
"2.30"
]
]
},
{
"name": "jsonschema",
"specs": []
},
{
"name": "GitPython",
"specs": [
[
">=",
"3.1.32"
]
]
},
{
"name": "rfc3987",
"specs": []
},
{
"name": "requests-cache",
"specs": []
},
{
"name": "xmltodict",
"specs": []
},
{
"name": "jsonpointer",
"specs": [
[
"~=",
"2.4"
]
]
},
{
"name": "setuptools",
"specs": []
}
],
"lcname": "ogc-na"
}
JSON
