Metadata-Version: 2.1
Name: azure-purview-catalog
Version: 1.0.0b4
Summary: Microsoft Azure Azure Purview Catalog Client Library for Python
Home-page: https://github.com/Azure/azure-sdk-for-python
Author: Microsoft Corporation
Author-email: azpysdkhelp@microsoft.com
License: MIT License
Description: # Azure Purview Catalog client library for Python
        
        Azure Purview Catalog is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At the same time, Data Catalog helps organizations get more value from their existing investments.
        
        - Search for data using technical or business terms
        - Browse associated technical, business, semantic, and operational metadata
        - Identify the sensitivity level of data.
        
        **Please rely heavily on the [service's documentation][catalog_product_documentation] and our [client docs][request_builders_and_client] to use this library**
        
        [Source code][source_code] | [Package (PyPI)][catalog_pypi] | [API reference documentation][catalog_ref_docs]| [Product documentation][catalog_product_documentation]
        
        ## _Disclaimer_
        
        _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_
        
        ## Getting started
        
        ### Prerequisites
        
        - Python 3.6 or later is required to use this package.
        - You must have an [Azure subscription][azure_subscription] and a [Purview][purview_resource] to use this package.
        
        #### Create a Purview Resource
        
        Follow [these][purview_resource] instructions to create your Purview resource
        
        ### Install the package
        
        Install the Azure Purview Catalog client library for Python with [pip][pip]:
        
        ```bash
        pip install azure-purview-catalog
        ```
        
        ### Authenticate the client
        
        To use an [Azure Active Directory (AAD) token credential][authenticate_with_token],
        provide an instance of the desired credential type obtained from the
        [azure-identity][azure_identity_credentials] library.
        
        To authenticate with AAD, you must first [pip][pip] install [`azure-identity`][azure_identity_pip] and
        [enable AAD authentication on your Purview resource][enable_aad]
        
        After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
        As an example, [DefaultAzureCredential][default_azure_credential]
        can be used to authenticate the client:
        
        Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
        AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
        
        Use the returned token credential to authenticate the client:
        
        ```python
        from azure.purview.catalog import PurviewCatalogClient
        from azure.identity import DefaultAzureCredential
        
        credential = DefaultAzureCredential()
        client = PurviewCatalogClient(endpoint="https://<my-account-name>.purview.azure.com", credential=credential)
        ```
        
        ## Key concepts
        
        ### Client
        
        This package offers request builders so you can build http requests and send these requests to the service using the `send_request` method.
        For more information on how to use request builders and our clients, see [here][request_builders_and_client].
        
        ## Examples
        
        The following section shows you how to initialize and authenticate your client, then get all of your type-defs.
        
        - [Get All Type Definitions](#get-all-type-definitions "Get All Type Definitions")
        
        ### Get All Type Definitions
        
        ```python
        from azure.purview.catalog import PurviewCatalogClient
        from azure.identity import DefaultAzureCredential
        from azure.core.exceptions import HttpResponseError
        
        credential = DefaultAzureCredential()
        client = PurviewCatalogClient(endpoint="https://<my-account-name>.purview.azure.com", credential=credential)
        try:
            response = client.types.get_all_type_definitions()
            # print out all of your entity definitions
            print(response['entityDefs'])
        
        except HttpResponseError as e:
            print(e)
        ```
        
        ## Troubleshooting
        
        ### General
        
        The Purview Catalog client will raise exceptions defined in [Azure Core][azure_core] if you call `.raise_for_status()` on your responses.
        
        ### Logging
        
        This library uses the standard
        [logging][python_logging] library for logging.
        Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
        level.
        
        Detailed DEBUG level logging, including request/response bodies and unredacted
        headers, can be enabled on a client with the `logging_enable` keyword argument:
        
        ```python
        import sys
        import logging
        from azure.identity import DefaultAzureCredential
        from azure.purview.catalog import PurviewCatalogClient
        
        # Create a logger for the 'azure' SDK
        logger = logging.getLogger('azure')
        logger.setLevel(logging.DEBUG)
        
        # Configure a console output
        handler = logging.StreamHandler(stream=sys.stdout)
        logger.addHandler(handler)
        
        endpoint = "https://<my-account-name>.purview.azure.com"
        credential = DefaultAzureCredential()
        
        # This client will log detailed information about its HTTP sessions, at DEBUG level
        client = PurviewCatalogClient(endpoint=endpoint, credential=credential, logging_enable=True)
        ```
        
        Similarly, `logging_enable` can enable detailed logging for a single `send_request` call,
        even when it isn't enabled for the client:
        
        ```python
        result = client.types.get_all_type_definitions(logging_enable=True)
        ```
        
        ## Next steps
        
        For more generic samples, see our [client docs][request_builders_and_client].
        
        ## Contributing
        
        This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla].
        
        When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
        
        This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.
        
        <!-- LINKS -->
        
        [source_code]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/purview/azure-purview-catalog/azure/purview/catalog
        [catalog_pypi]: https://aka.ms/azsdk/python/purviewcatalog/pypi
        [catalog_ref_docs]: https://aka.ms/azsdk/python/purviewcatalog/ref-docs
        [catalog_product_documentation]: https://azure.microsoft.com/services/purview/
        [azure_subscription]: https://azure.microsoft.com/free/
        [purview_resource]: https://docs.microsoft.com/azure/purview/create-catalog-portal
        [pip]: https://pypi.org/project/pip/
        [authenticate_with_token]: https://docs.microsoft.com/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-an-authentication-token
        [azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
        [azure_identity_pip]: https://pypi.org/project/azure-identity/
        [default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential
        [request_builders_and_client]: https://aka.ms/azsdk/python/protocol/quickstart
        [enable_aad]: https://docs.microsoft.com/azure/purview/create-catalog-portal#add-a-security-principal-to-a-data-plane-role
        [azure_core]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md
        [python_logging]: https://docs.python.org/3.5/library/logging.html
        [cla]: https://cla.microsoft.com
        [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
        [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
        [coc_contact]: mailto:opencode@microsoft.com
        
        
        # Release History
        
        
        ## 1.0.0b4 (2022-06-13)
        
        **Features**
        
          - Support Atlas 2.2 APIs
        
        **Bugs Fixed**
        
          - Add missing query parameter `includeTermHierarchy` for update term API
          - Add missing query parameter `excludeRelationshipTypes` for get term API
        
        ## 1.0.0b3 (2022-03-15)
        
        **Bugs Fixed**
        
          - Fix `delete_by_guids` to get rid of bad request error #22487
        
        ## 1.0.0b2 (2021-09-29)
        
        **Features**
        
          - Add convenience operations to client
        
        **Breaking changes**
        
          - Remove rest layer and request builders(detailed description is in `README.md`)
          - The HttpRequest parameter to send_request has changed from `http_request` to `request`
          - Ordering of endpoint and credential params have changed
        
        
        ## 1.0.0b1 (2021-05-11)
        
        - This is the initial release of the Azure Purview Catalog library.
        
Keywords: azure,azure sdk
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
