Metadata-Version: 2.1
Name: pvclient
Version: 0.0.10
Summary: This package allows interacting with Azure Purview's REST API.
Home-page: https://github.com/Thanh-Truong/purview
Author: Thanh Truong
Author-email: tcthanh@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# Introduction
This is a HTTP client to [Purview](https://azure.microsoft.com/sv-se/services/purview/) as the complemntary of Python [wrapper](https://github.com/wjohnson/pyapacheatlas) for Appache Atlas.

# Installation

Install the package
```
pip install --upgrade pvclient
```
then it will be uninstalled with
```
pip uninstall pvclient
```

# Authentication

Set the following environment variables:
* TENANT_ID =<Tentant id where Purview accounts are provisioned under>
* CLIENT_ID =<Client id of a service principal which is used to run the program>
* CLIENT_SECRET =<Client secret of a service principal which is used to run the program>
* SUBSCRIPTION_ID =<Subscription id where Purview accounts are provisioned under>
* INTERACTIVEGROUPS=<Id of group(s) who interactively logs into Purview>

# Configurations:

Set the following environment variables:
* RESOURCE_GROUP =<Resource group name>
* LOCATION =<Location>
* PURVIEW_ACCOUNT_NAME=<Purview account to be created/modified >

# Usage:
```
purview [-h] [--create-purview] [--assign-roles] [--delete-purview] [--create-glossary CREATE_GLOSSARY] [--list-terms] [--upload-entities]
                  [--import-terms IMPORT_TERMS] [--delete-term DELETE_TERM] [--delete-all-terms] [--list-term-templates]
                  [--import-term-templates IMPORT_TERM_TEMPLATES] [--delete-term-templates DELETE_TERM_TEMPLATES]

Interaction with Purview

optional arguments:
  -h, --help            show this help message and exit
  --create-purview
  --assign-roles
  --delete-purview
  --create-glossary CREATE_GLOSSARY
                        Create a glossary with name
  --list-terms
  --upload-entities
  --import-terms IMPORT_TERMS
  --delete-term DELETE_TERM
                        Delete a term from the default Glossary
  --delete-all-terms    Delete all terms from the default Glossary
  --list-term-templates
                        List all term templates from the default Glossary
  --import-term-templates IMPORT_TERM_TEMPLATES
                        Import term templates from a file to the default Glossary
  --delete-term-templates DELETE_TERM_TEMPLATES
                        Delete all templates from a file from the default Glossary
```


