Skip to content

Python package to load user-specified metadata models into Google Cloud Data Catalog, comprising Custom Entries, Tag Templates, and Tags

License

Notifications You must be signed in to change notification settings

ricardolsmendes/datacatalog-custom-model-manager

Repository files navigation

datacatalog-custom-model-manager

A Python package intended to load user-specified metadata models into Google Cloud Data Catalog, comprising Custom Entries, Tag Templates, and Tags.

It is powered by datacatalog-custom-entries- manager, datacatalog- tag-template-processor, and datacatalog-tag-manager, leveraging their features in the format of a single CLI.

license pypi issues continuous integration continuous delivery


Load Custom Model

From CSV files

  • SCHEMAS

Loading custom models from CSV requires a folder (--files-folder argument in the below commands) containing three files: entries.csv, tag_templates.csv, and tags.csv. Please refer to the following external resources for further details on their layouts:

FILE LAYOUT DOCUMENTATION
entries.csv datacatalog-custom-entries-manager README
tag_templates.csv datacatalog-tag-template-processor README
tags.csv datacatalog-tag-manager README
  • SAMPLE INPUT
  1. sample-input/egeria-business-glossary for reference;
  2. Sample metadata for datacatalog-custom-model-manager (Google Sheets) might help to create/export the mandatory CSV files.
  • COMMANDS

Python + virtualenv

pip install datacatalog-custom-model-manager

datacatalog-custom-model load \
  --files-folder <CSV-FILES-PATH> \
  --project-id <YOUR-PROJECT-ID> --location-id <YOUR-LOCATION-ID> \
  [--delete-existing-tag-templates]

Docker

docker build --rm --tag datacatalog-custom-model-manager .

docker run --rm --tty \
  --volume <CREDENTIALS-FILE-FOLDER>:/credentials --volume <CSV-FILE-FOLDER>:/data \
  datacatalog-custom-model-manager load \
  --files-folder <CSV-FILES-PATH> \
  --project-id <YOUR-PROJECT-ID> --location-id <YOUR-LOCATION-ID> \
  [--delete-existing-tag-templates]

How to contribute

Please make sure to take a moment and read the Code of Conduct.

Report issues

Please report bugs and suggest features via the GitHub Issues.

Before opening an issue, search the tracker for possible duplicates. If you find a duplicate, please add a comment saying that you encountered the problem as well.

Contribute code

Please make sure to read the Contributing Guide before making a pull request.

About

Python package to load user-specified metadata models into Google Cloud Data Catalog, comprising Custom Entries, Tag Templates, and Tags

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published