Metadata-Version: 2.1
Name: datacatalog-custom-model-manager
Version: 0.1.1
Summary: A package to load user-specified metadata models into Google Cloud Data Catalog
Home-page: https://github.com/ricardolsmendes/datacatalog-custom-model-manager
Author: Ricardo Mendes
Author-email: ricardolsmendes@gmail.com
License: MIT
Description: # datacatalog-custom-model-manager
        
        A Python package intended to load user-specified metadata models into Google Cloud Data Catalog,
        comprising [Custom Entries](https://cloud.google.com/data-catalog/docs/how-to/custom-entries), Tag
        Templates, and [Tags](https://cloud.google.com/data-catalog/docs/concepts/overview#tags).
        
        It is powered by [datacatalog-custom-entries-
        manager](https://github.com/ricardolsmendes/datacatalog-custom-entries-manager), [datacatalog-
        tag-template-processor](https://github.com/mesmacosta/datacatalog-tag-template-processor), and
        [datacatalog-tag-manager](https://github.com/ricardolsmendes/datacatalog-tag-manager), leveraging
        their features in the format of a single CLI.
        
        ![Continuous Integration](https://github.com/ricardolsmendes/datacatalog-custom-model-manager/workflows/Continuous%20Integration/badge.svg)
        ![Continuous Delivery](https://github.com/ricardolsmendes/datacatalog-custom-model-manager/workflows/Continuous%20Delivery/badge.svg)
        
        ---
        
        ## 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](https://github.com/ricardolsmendes/datacatalog-custom-entries-manager#211-to-a-csv-file)                                        |
        | `tag_templates.csv` | [datacatalog-tag-template-processor README](https://github.com/mesmacosta/datacatalog-tag-template-processor#21-create-a-csv-file-representing-the-templates-to-be-created) |
        | `tags.csv`          | [datacatalog-tag-manager README](https://github.com/ricardolsmendes/datacatalog-tag-manager#211-from-a-csv-file)                                                            |
        
        - *SAMPLE INPUT*
        
        1. [sample-input/egeria-business-glossary](https://github.com/ricardolsmendes/datacatalog-custom-model-manager/tree/master/sample-input/egeria-business-glossary)
           for reference;
        1. [Sample metadata for datacatalog-custom-model-manager](https://docs.google.com/spreadsheets/d/13MuxLjQGrD-A7R4p_3TGaVFCV3X0atWmyxIINQNF2R4)
           (Google Sheets) might help to create/export the mandatory CSV files.
        
        - *COMMANDS*
        
        **Python + virtualenv**
        
        ```shell script
        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**
        
        ```shell script
        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]
        ```
        
Platform: Posix; MacOS X; Windows
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
