Skip to content

Commit

Permalink
Updating README and incrementing version number
Browse files Browse the repository at this point in the history
  • Loading branch information
wjohnson committed Jan 10, 2021
1 parent 6b293d8 commit 750f7c6
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 11 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PyApacheAtlas: API Support for Apache Atlas and Azure Purview
# PyApacheAtlas: API Support for Azure Purview and Apache Atlas

A python package to work with the Apache Atlas API and support bulk loading, custom lineage, and more from a Pythonic set of classes and Excel templates.

Expand All @@ -16,6 +16,10 @@ The package currently supports:
* Working with the glossary.
* Uploading terms.
* Downloading individual or all terms.
* Working with classifications.
* Classify one entity with multiple classifications.
* Classify multiple entities with a single classification.
* Remove classification ("declassify") from an entity.
* Working with relationships.
* Able to create arbitrary relationships between entities.
* e.g. associating a given column with a table.
Expand All @@ -33,30 +37,33 @@ The package currently supports:
python -m pip install pyapacheatlas
```

### Create a Client Connection
### Create a Purview Client Connection

Provides connectivity to your Atlas / Azure Purview service.
Supports getting and uploading entities and type defs.

```
from pyapacheatlas.auth import ServicePrincipalAuthentication
from pyapacheatalas.core import AtlasClient
from pyapacheatlas.core import PurviewClient
auth = ServicePrincipalAuthentication(
tenant_id = "",
client_id = "",
client_secret = ""
)
# Azure Purview Endpoints are:
# https://{your_catalog_name}.catalog.purview.azure.com/api/atlas/v2
client = AtlasClient(
endpoint_url = "https://MYENDPOINT/api/atlas/v2",
auth = auth
# Create a client to connect to your service.
client = PurviewClient(
account_name = "Your-Purivew-Account-Name",
authentication = auth
)
```

For users wanting to use the `AtlasClient` and Purview, the Atlas Endpoint for
Purview is `https://{your_purivew_name}.catalog.purview.azure.com/api/atlas/v2`.
The PurviewClient abstracts away having to know the endpoint url and is
the better way to use this package with Purview.

### Create Entities "By Hand"

You can also create your own entities by hand with the helper `AtlasEntity` class. Convert it with `to_json` to prepare it for upload.
Expand Down Expand Up @@ -100,3 +107,4 @@ Learn more about the Excel [features and configuration in the wiki](https://gith
* Learn more about this package in the [github wiki](https://github.com/wjohnson/pyapacheatlas/wiki/Excel-Template-and-Configuration).
* The [Apache Atlas client in Python](https://pypi.org/project/pyatlasclient/)
* The [Apache Atlas REST API](http://atlas.apache.org/api/v2/)
* The [Purview CLI Package](https://github.com/tayganr/purviewcli) provides CLI support.
2 changes: 1 addition & 1 deletion pyapacheatlas/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.1.1"
__version__ = "0.2.0"
6 changes: 5 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from pyapacheatlas import __version__

LONG_DESCRIPTION = """
# PyApacheAtlas: API Support for Apache Atlas and Azure Purview
# PyApacheAtlas: API Support for Azure Purview and Apache Atlas
A python package to work with the Apache Atlas API and support bulk loading, custom lineage, and more from a Pythonic set of classes and Excel templates.
Expand All @@ -20,6 +20,10 @@
* Working with the glossary.
* Uploading terms.
* Downloading individual or all terms.
* Working with classifications.
* Classify one entity with multiple classifications.
* Classify multiple entities with a single classification.
* Remove classification ("declassify") from an entity.
* Working with relationships.
* Able to create arbitrary relationships between entities.
* e.g. associating a given column with a table.
Expand Down

0 comments on commit 750f7c6

Please sign in to comment.