Pyapacheatlas

New Features

* Enable passing arguments to the underlying requests package. This supports 181 by enabling a configuration such as:

python
client = PurviewClient(
purview_name="myservicename",
authentication=cred,
requests_verify=False
)


* The `search_entities` method now accepts a `body` parameter which acts like the `body` in the `query` method. (184)

Breaking Changes

* Deprecated TablesLineage and FineGrainColumnLineage from the Excel template. To reenable these tabs, pass `--include-deprecated` to the `pyapacheatlas -m --make-template path.xlsx` command or `include_deprecated=True` to the `make_template()` method (188)

Bug Fixes

* The Excel sheet was failing when only `owners` was provided and `experts` was omitted. The `owners` column can now be specified by itself and the ExcelReader can properly parse the column. (183)
* When defining an `AtlasAttributeDef` you can now pass in any of the `Cardinality` enum options and the `AtlasAttributeDef` will extract the enum value automatically (185).

New Features

* Added support for Purview's [DiscoveryREST API endpoints](https://docs.microsoft.com/en-us/rest/api/purview/catalogdataplane/discovery)

Breaking Changes

* PurviewClient.search_entities is now deprecated. Please migrate to PurviewClient.discover.search_entities.

Bug Fixes

* `GlossaryClient.assignTerm` incorrectly referenced `get_glossary_term` when using termName.
* `GlossaryClient.delete_assignedTerm` incorrectly referenced `get_glossary_term` when using termName.
* `GlossaryClient.get_termAssignedEntities` incorrectly referenced `get_glossary_term` when using termName.

Minor Changes

* `GlossaryClient.assignTerm` now supports passing in a glossary_guid to speed up operations when using termName.
* `GlossaryClient.delete_assignedTerm` now supports passing in a glossary_guid to speed up operations when using termName.
* `GlossaryClient.get_termAssignedEntities` now supports passing in a glossary_guid to speed up operations when using termName.

New Features

MS Graph and Helping to Support Expert and Owner Lookup

* For Purview users, introduced a utility function for the MS Graph, making it easier to look up user object ids.
* `PurviewClient.msgraph.upn_to_id`
* `PurviewClient.msgraph.email_to_id`
* After introducing these utility functions, the `ExcelReader.parse_bulk_entities` method takes a `contacts_func`.
* The contacts_func parameter takes a function and will be executed for every contact provided in the experts and owners columns.

AtlasObjectId to Avoid Updating Existing Required Relationships

* The `ExcelReader.parse_bulk_entities` now supports using an `AtlasObjectId` as a reference in the `[Relationship]`.
* For example, if you wanted to reference an existing entity without uploading it in the BulkEntities tab, you would use...
* `AtlasObjectId(guid:xx-yy-zz)` or `AtlasObjectId(typeName:someType qualifiedName:someQualifiedName)`.
* This would be the value inside of a `[Relationship] xyz` column where xyz is the relationship attribute name.
* This is really useful when you have a required relationship (like azure_sql_schema for an azure_sql_table) that also has a required relationship.
* This lets you reference only the first dependency and you don't risk changing anything like the name or having to deal with required types.

* The `PurviewClient` and `AtlasClient` now have a `glossary` property which supports many of the glossary endpoints.
* In addition a `PurviewGlossaryTerm` and an `AtlasGlossaryTerm` class are provided.
* `PurviewGlossaryTerm` supports term hierarchy with the `add_hierarchy` method.

* For current Atlas users, added support for defining businessMetadataDefs.
* For current Atlas users, added support for the label endpoints by introducing:
* `AtlasClient.update_entity_labels`
* `AtlasClient.delete_entity_labels`
* For current Atlas users (and one day Purview users too), added support for customAttributes in the excel upload by using a column header `[custom] myAttribute`.

Breaking Changes

* Added a deprecation warning around the `AtlasClient` glossary methods. Users should migrate to `AtlasClient.glossary` or `PurviewClient.glossary`.

Fixes

* Fixing the CLI so that config is not necessary.

New Features

* Supports the GET /entity/{guid} with `get_single_entity` method (136)
* Supports the ignoreRelationship and minExtInfo parameters in the get_single_entity and get_entity methods (134)
* Now supports the delete_relationship endpoint based on relationshipGuid (139)
* Now supports the DELETE /types/typedefs (138) where you pass an AtlasTypeDef with entityDefs, relationshipDefs, etc.
* Added support for Apache Atlas labels in the excel bulk entities upload with `[root] labels` (131)
* Supports a configurable excel template (124) generation by passing in kwargs as defined in ExcelConfiguration.
* Adds a CLI command (143) that lets you create the excel template: `python -m pyapacheatlas --make-template ./test.xlsx`
* `AtlasEntity.from_json()` will take in a dictionary that matches the AtlasEntity schema and then convert it into an AtlasEntity object!

Breaking Changes

* Added a deprecation warning around the `classification` column in the template, it's no longer required and instead should be `[root] classifications`.
* partial_update_entity might have raised a key error if the entity was not found, now it will raise a Value Error with a more explicit message (129)

Bug Fixes

* Fixed issue with parse_classification_defs for subType (142)
* Fixed docstring for get_entity_header to reference only guid (144)
* partial_update_entity might have raised a key error if the entity was not found, now it will raise a Value Error with a more explicit message (129)