Apache Atlas DCAT library¶

atlasdcat package¶

Submodules¶

atlasdcat.attribute module¶

Attribute module for mapping an Atlas Glossery to DCAT rdf.

class atlasdcat.attribute.Attribute(value)¶

Bases: str, Enum

Attribute enum.

ACCESS_RIGHTS = 'accessRights'¶

ACCESS_URL = 'accessURL'¶

CONTACT_EMAIL = 'contactEmail'¶

CONTACT_NAME = 'contactName'¶

DATASET = 'Dataset'¶

DISTRIBUTION = 'Distribution'¶

DOWNLOAD_URL = 'downloadURL'¶

FORMAT = 'format'¶

FREQUENCY = 'frequency'¶

GENERATED = 'generated'¶

INCLUDE_IN_DCAT = 'includeInDCAT'¶

KEYWORD = 'keyword'¶

LICENSE = 'license'¶

PUBLISHER = 'publisher'¶

SPATIAL = 'spatial'¶

SPATIAL_RESOLUTION_IN_METERS = 'spatialResolutionInMeters'¶

TEMPORAL_END_DATE = 'temporalEndDate'¶

TEMPORAL_RESOLUTION = 'temporalResolution'¶

TEMPORAL_START_DATE = 'temporalStartDate'¶

THEME = 'theme'¶

TITLE = 'title'¶

atlasdcat.glossaryclient module¶

AtlasClient module for mapping an Atlas Glossery to DCAT rdf.

class atlasdcat.glossaryclient.AtlasGlossaryClient(endpoint_url, authentication, **kwargs)¶

Bases: GlossaryClient

Class for Atlas Glossary REST Client.

update_term(term, **kwargs)¶

Update a single term to Apache Atlas.

Provide an AtlasGlossaryTerm or dictionary.

Parameters

term (Union[Dict, _CrossPlatformTerm]) – The term to be updated.
kwargs (Dict) – The parameters to pass into the url.

Return type

Dict

Returns

The updated term’s current state.

Raises

TypeError – A type error

atlasdcat.mapper module¶

Mapper module for mapping an Atlas Glossery to DCAT rdf.

This module contains methods for mapping an Atlas Glossery to DCAT rdf according to the dcat-ap-no v.2 standard

Example

Setup the AtlasDcatMapper. >>> from atlasdcat import AtlasDcatMapper, AtlasGlossaryClient >>> from pyapacheatlas.auth import BasicAuthentication >>> >>> atlas_auth = BasicAuthentication(username=”dummy”, password=”dummy”) >>> atlas_client = AtlasGlossaryClient( >>> endpoint_url=”http://atlas”, authentication=atlas_auth >>> ) >>> >>> mapper = AtlasDcatMapper( >>> glossary_client=atlas_client, >>> glossary_id=”myglossary”, >>> catalog_uri=”https://example.com/catalog”, >>> catalog_language=”http://publications.europa.eu/resource/authority/language/NOB”, >>> catalog_title=”Catalog”, >>> catalog_publisher=”https://domain/publisher”, >>> dataset_uri_template=”http://domain/datasets/{guid}”, >>> distribution_uri_template=”http://domain/distributions/{guid}”, >>> language=”nb”, >>> )

Map glossary terms to DCAT Catalog >>> try: >>> mapper.fetch_glossary() >>> catalog = mapper.map_glossary_terms_to_dataset_catalog() >>> print(catalog.to_rdf()) >>> except Exception as e: >>> print(f”An exception occurred: {e}”)

>>> catalog = Catalog()
>>> catalog.identifier = "http://catalog-uri"
>>> catalog.title = {"nb": "mytitle"}
>>> catalog.publisher = "http://publisher"
>>> catalog.language = ["nb"]
>>> catalog.license = ""

>>> dataset = Dataset()
>>> dataset.title = {"nb": "Dataset"}
>>> dataset.description = {"nb": "Dataset description"}
>>> catalog.datasets = [dataset]
>>>
>>> try:
>>>  6+
 mapper.fetch_glossary()
        mapper.map_dataset_catalog_to_glossary_terms(catalog)
        mapper.save_glossary_terms()
    except Exception as e:
        print(f"An exception occurred: {e}")

class atlasdcat.mapper.AtlasDcatMapper(glossary_client, glossary_id, catalog_uri, catalog_language, catalog_title, catalog_publisher, dataset_uri_template, distribution_uri_template, language='nb', attr_mapping=None, is_purview=None, include_approved_only=False)¶

Bases: object

Class for mapping Atlas Glossary terms to DCAT catalog.

fetch_glossary()¶

Fetch detailed glossary.

Return type: None

property glossary_terms: List[Dict]¶

List[Dict], the persisted glossary terms.

Return type: List[Dict]

map_dataset_catalog_to_glossary_terms(catalog)¶

Map dcat dataset catalog RDF resource to glossary terms.

Parameters

catalog (Catalog) – A dataset catalog RDF resource

Raises

MappingError – A mapping error if the language does not match
InvalidStateError – If glossary is not fetched before calling this function

Return type

None

map_glossary_terms_to_dataset_catalog()¶

Map glossary terms to dcat dataset catalog RDF resource.

Return type: Catalog
Returns: A catalog RDF resource.
Raises: InvalidStateError – If glossary is not fetched before calling this function

save_glossary_terms()¶

Save glossary terms.

Raises: InvalidStateError – If there are no terms to save.
Return type: None

property tmp_glossary_terms: List[Dict]¶

Dict, the temporary glossary terms.

Return type: List[Dict]

exception atlasdcat.mapper.FormatError¶

Bases: MappingError

Exception class for format errors.

exception atlasdcat.mapper.InvalidStateError¶

Bases: MappingError

Exception class for invalid state errors.

exception atlasdcat.mapper.MappingError¶

Bases: Exception

Exception class for mapping errors.

exception atlasdcat.mapper.TemporalError¶

Bases: MappingError

Exception class for temporal errors.

atlasdcat.termtype module¶

Termtype module for mapping an Atlas Glossery to DCAT rdf.

class atlasdcat.termtype.TermType(value)¶

Bases: Enum

Term type enum.

DATASET = 1¶

DISTRIBUTION = 2¶

UNKNOWN = -1¶

Module contents¶

atlasdcat package.

example¶

Very simple server exposing an API with the DCAT-representation.

NOT suited for production use

Requirements¶

.env in a basic auth scenario:

BASIC_AUTH_USERNAME=dummy
BASIC_AUTH_ATLAS_PASSWORD=dummy
ATLAS_ENDPOINT_URL=http://your.atlas.host.com/api/atlas/v2

If you run against openID connect (e.g. in Azure Purview scenario), this is what you need to put in your .env:

SERVICE_PRINCIPLE_TENANT_ID=
SERVICE_PRINCIPLE_CLIENT_ID=
SERVICE_PRINCIPLE_CLIENT_SECRET=very_secret_secret
ATLAS_ENDPOINT_URL=http://your.purview.host.com/catalog/api/atlas/v2

Setup local Apache Atlas server¶

cd atlas
docker-compose up

After building the atlas docker image, docker-compose will start the following services: atlas-server, kafka and zookeeper. Starting the Apache Atlas server can take up to 10 minutes. Be patient.

Wait for the following message:

atlas-server_1 | Apache Atlas Server started!!!
atlas-server_1 | 
atlas-server_1 | waiting for atlas to be ready
atlas-server_1 | .....
atlas-server_1 | Server: Apache Atlas
...
atlas-server_1 | glossary created
atlas-server_1 | Done setting up Atlas

Configuration (.env file)

GLOSSARY_ID=xxxx
BASIC_AUTH_USERNAME=admin
BASIC_AUTH_ATLAS_PASSWORD=admin
ATLAS_ENDPOINT_URL=http://localhost:21000/api/atlas/v2

Run following command to get the glossary ID

curl -u admin:admin  http://localhost:21000/api/atlas/v2/glossary

This will output something like this. Look for the value for “guid”.

[{"guid":"2c453c5e-6d47-4fcc-ae17-d1753ab72abb","qualifiedName":"myglossary",
"name":"myglossary", "terms":[{"termGuid":"0181bc5d-58aa-4194-8c5e-c8267a305ead",
"relationGuid":"1d94e821-bf9e-4d12-b145-35b66d5be2ee","displayText":"dataset"}]}]

Usage¶

% poetry run python simple-server.py

In another shell:

Fetch data catalog as RDF

% curl http://localhost:8081/catalog

Save data catalog as Glossary Terms to Apache Atlas.

The dataset identifier should be omitted when a dataset does not exist in Atlas. The mapper will generate an identifier.

% curl -X POST -H "Content-Type: application/json" \
    -d '{ 
        "_type": "Catalog",
        "access_rights_comments": [],
        "catalogrecords": [
            {
                "_type": "CatalogRecord",
                "conforms_to": [],
                "identifier": "http://example.com/catalog-record/1"
            }
        ],
        "conforms_to": [],
        "datasets": [
            {
                "_type": "Dataset",
                "access_rights_comments": [],
                "conforms_to": [],
                "distributions": [],
                "frequency": "http://WEEKLY",
                "is_referenced_by": [],
                "landing_page": [],
                "language": [],
                "qualified_attributions": [],
                "qualified_relation": [],
                "resource_relation": [],
                "theme": [],
                "title": {"en": "Dataset 1", "nb": "Datasett 1"},
                "description": {"en": "Dataset 1 description", "nb": "Datasett 1 beskrivelse"}
            },
            {
                "_type": "Dataset",
                "access_rights_comments": [],
                "conforms_to": [],
                "distributions": [],
                "is_referenced_by": [],
                "landing_page": [],
                "language": [],
                "qualified_attributions": [],
                "qualified_relation": [],
                "resource_relation": [],
                "theme": [],
                "title": {"en": "Dataset 2", "nb": "Datasett 2"},
                "description": {"en": "Dataset 2 description", "nb": "Datasett 2 beskrivelse"}
            }
        ],
        "description": {"en": "Description", "nb": "Beskrivelse"},
        "identifier": "http://example.com/catalogs/1",
        "is_referenced_by": [],
        "landing_page": [],
        "language": ["en", "nb"],
        "qualified_attributions": [],
        "qualified_relation": [],
        "resource_relation": [],
        "themes": [],
        "title": {"en": "This catalog", "nb": "Denne katalogen"}
    }' \
    http://localhost:8081/catalog

License¶

Apache License

Version 2.0, January 2004

http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

Definitions.

“License” shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

“Licensor” shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

“Legal Entity” shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, “control” means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

“You” (or “Your”) shall mean an individual or Legal Entity exercising permissions granted by this License.

“Source” form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

“Object” form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

“Work” shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

“Derivative Works” shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

“Contribution” shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, “submitted” means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as “Not a Contribution.”

“Contributor” shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of this License; and

You must cause any modified files to carry prominent notices stating that You changed the files; and

You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

If the Work includes a “NOTICE” text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets “[]” replaced with your own identifying information. (Don’t include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same “printed page” as the copyright notice for easier identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A Python library for mapping Apache Atlas Glossary terms to DCAT metadata and vice versa.

Specifications the Norwegian Application Profile of the DCAT standard.

Installation¶

To install the datacatalogtordf package, run this command in your terminal:

$ pip install atlasdcat

Usage¶

Setup Atlas DCAT Mapper:

from atlasdcat import AtlasDcatMapper, AtlasGlossaryClient
from pyapacheatlas.auth import BasicAuthentication

atlas_auth = BasicAuthentication(username="dummy", password="dummy")
atlas_client = AtlasGlossaryClient(
    endpoint_url="http://atlas", authentication=atlas_auth
)

mapper = AtlasDcatMapper(
    glossary_client=atlas_client,
    glossary_id="myglossary",
    catalog_uri="https://domain/catalog",
    catalog_language="http://publications.europa.eu/resource/authority/language/NOB",
    catalog_title="Catalog",
    catalog_publisher="https://domain/publisher",
    dataset_uri_template="http://domain/datasets/{guid}",
    distribution_uri_template="http://domain/distributions/{guid}",
    language="nb",
)

Map Apache Atlas Glossary terms to DCAT RDF (turtle):

try:
    mapper.fetch_glossary()
    catalog = mapper.map_glossary_terms_to_dataset_catalog()
    print(catalog.to_rdf())
except Exception as e:
    print(f"An exception occurred: {e}")

Map DCAT RDF Catalog to Apache Atlas Glossary terms:

catalog = Catalog()
catalog.identifier = "http://catalog-uri"
catalog.title = {"nb": "mytitle"}
catalog.publisher = "http://publisher"
catalog.language = ["nb"]
catalog.license = ""

dataset = Dataset()
dataset.title = {"nb": "Dataset"}
dataset.description = {"nb": "Dataset description"}
catalog.datasets = [dataset]

try:
    mapper.fetch_glossary()
    mapper.map_dataset_catalog_to_glossary_terms(catalog)
    mapper.save_glossary_terms()
except Exception as e:
    print(f"An exception occurred: {e}")

For an example of usage of this library in a simple server, see example .