A package to manage Google Cloud Data Catalog Tag Template export scripts
Project description
Datacatalog Tag Template Exporter
A Python package to manage Google Cloud Data Catalog Tag Template export scripts.
Disclaimer: This is not an officially supported Google product.
Table of Contents
- Executing in Cloud Shell
- 1. Environment setup
- 2. Export Templates to CSV file
Executing in Cloud Shell
# Set your SERVICE ACCOUNT, for instructions go to 1.3. Auth credentials
# This name is just a suggestion, feel free to name it following your naming conventions
export GOOGLE_APPLICATION_CREDENTIALS=~/datacatalog-tag-template-exporter-sa.json
# Install datacatalog-tag-template-exporter
pip3 install datacatalog-tag-template-exporter --user
# Add to your PATH
export PATH=~/.local/bin:$PATH
# Look for available commands
datacatalog-tag-template-exporter --help
1. Environment setup
1.1. Python + virtualenv
Using virtualenv is optional, but strongly recommended unless you use Docker.
1.1.1. Install Python 3.6+
1.1.2. Get the source code
git clone https://github.com/mesmacosta/datacatalog-tag-template-exporter
cd ./datacatalog-tag-template-exporter
All paths starting with ./
in the next steps are relative to the datacatalog-tag-template-exporter
folder.
1.1.3. Create and activate an isolated Python environment
pip install --upgrade virtualenv
python3 -m virtualenv --python python3 env
source ./env/bin/activate
1.1.4. Install the package
pip install --upgrade .
1.2. Docker
Docker may be used as an alternative to run the script. In this case, please disregard the Virtualenv setup instructions.
1.3. Auth credentials
1.3.1. Create a service account and grant it below roles
- Data Catalog Admin
1.3.2. Download a JSON key and save it as
This name is just a suggestion, feel free to name it following your naming conventions
./credentials/datacatalog-tag-template-exporter-sa.json
1.3.3. Set the environment variables
This step may be skipped if you're using Docker.
export GOOGLE_APPLICATION_CREDENTIALS=~/credentials/datacatalog-tag-template-exporter-sa.json
2. Export Templates to CSV file
2.1. A CSV file representing the Templates will be created
Templates are composed of as many lines as required to represent all of their fields. The columns are described as follows:
Column | Description |
---|---|
template_name | Resource name of the Tag Template for the Tag. |
display_name | Resource name of the Tag Template for the Tag. |
field_id | Id of the Tag Template field. |
field_display_name | Display name of the Tag Template field. |
field_type | Type of the Tag Template field. |
enum_values | Values for the Enum field. |
2.2. Run the datacatalog-tag-template-exporter script
- Python + virtualenv
datacatalog-tag-template-exporter tag-templates export --project-ids my-project --file-path CSV_FILE_PATH
History
0.1.0 (2020-04-15)
- First release on PyPI.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for datacatalog-tag-template-exporter-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cb7d5cf1868dfa5a1d18461841fdc8751085bf6e7d2bfafce221d0614b925a4 |
|
MD5 | 9a6b17aabebe50120b16084daa565752 |
|
BLAKE2b-256 | fbaef717b43032bff73c5f78bddd12d796ea52b0a978c20d9b2ba9b13a9f7817 |
Hashes for datacatalog_tag_template_exporter-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b4fd5228a971397d11e715758140528f36bb85690d3c5e95db5777111a69455 |
|
MD5 | 5a1062a55007f4d43c0cec24de5a9e68 |
|
BLAKE2b-256 | ba5de2db55169df6ce1bccca1f7cbd12a9676044dcb03a4c3d273d22956887d7 |