Skip to content

Commit

Permalink
Preparing for 0.1.0 Release
Browse files Browse the repository at this point in the history
  • Loading branch information
wjohnson committed Dec 7, 2020
1 parent b8111f9 commit d05ab8f
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 35 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,6 @@ tester.py
*.xlsx
*.bat
.ignore/
migration/
migration/

.pypirc
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PyApacheAtlas
# PyApacheAtlas: API Support for Apache Atlas and Azure Purview

A python package to work with the Apache Atlas API and support bulk loading from different file types.
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.

The package currently supports:
* Creating a column lineage scaffolding as in the [Hive Bridge style](https://atlas.apache.org/0.8.3/Bridge-Hive.html).
Expand All @@ -10,12 +10,13 @@ The package currently supports:
* Column entities
* Table lineage processes
* Column lineage processes
* Supports Azure Data Catalog ColumnMapping Attributes.
* From excel, bulk uploading entities, creating / updating lineage, and creating custom types.
* Supports Azure Purview ColumnMapping attributes.
* Performing "What-If" analysis to check if...
* Your entities are valid types.
* Your entities are missing required attributes.
* Your entities are using undefined attributes.
* Authentication to Azure Data Catalog via Service Principal.
* Authentication to Azure Purview via Service Principal.
* Authentication using basic authentication of username and password.

## Quickstart
Expand All @@ -25,14 +26,12 @@ The package currently supports:
Create a wheel distribution file and install it in your environment.

```
python -m pip install wheel
python setup.py bdist_wheel
python -m pip install ./dist/pyapacheatlas-0.0b15-py3-none-any.whl
python -m pip install pyapacheatlas
```

### Create a Client Connection

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

```
Expand All @@ -45,8 +44,8 @@ auth = ServicePrincipalAuthentication(
client_secret = ""
)
# Azure Data Catalog Endpoints are:
# https://{your_catalog_name}.catalog.babylon.azure.com/api/atlas/v2
# Azure Purview Endpoints are:
# https://{your_catalog_name}.catalog.purview.azure.com/api/atlas/v2
client = AtlasClient(
endpoint_url = "https://MYENDPOINT/api/atlas/v2",
Expand Down
2 changes: 1 addition & 1 deletion pyapacheatlas/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.0b15"
__version__ = "0.1.0"
70 changes: 47 additions & 23 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,27 +1,51 @@
import setuptools
from pyapacheatlas import __version__

with open("README.md", "r") as fh:
long_description = fh.read()
LONG_DESCRIPTION = """
# PyApacheAtlas: API Support for Apache Atlas and Azure Purview
setuptools.setup(
name="pyapacheatlas",
version=__version__,
author="Will Johnson",
author_email="[email protected]",
description="A package to simplify working with the Apache Atlas REST APIs and support bulk loading from files.",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/wjohnson/pyapacheatlas",
packages=setuptools.find_packages(),
install_requires=[
'openpyxl>=3.0',
'requests>=2.0'
],
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires='>=3.6',
)
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.
The package currently supports:
* Creating a column lineage scaffolding as in the [Hive Bridge style](https://atlas.apache.org/0.8.3/Bridge-Hive.html).
* Creating and reading from an excel template file
* From Excel, constructing the defined entities and column lineages.
* Table entities
* Column entities
* Table lineage processes
* Column lineage processes
* From excel, bulk uploading entities, creating / updating lineage, and creating custom types.
* Supports Azure Purview ColumnMapping attributes.
* Performing "What-If" analysis to check if...
* Your entities are valid types.
* Your entities are missing required attributes.
* Your entities are using undefined attributes.
* Authentication to Azure Purview via Service Principal.
* Authentication using basic authentication of username and password.
"""

def setup_package():
setuptools.setup(
name="pyapacheatlas",
version=__version__,
author="Will Johnson",
author_email="[email protected]",
description="A package to simplify working with the Apache Atlas REST APIs for Atlas and Azure Purview.",
long_description_content_type="text/markdown",
url="https://github.com/wjohnson/pyapacheatlas",
packages=setuptools.find_packages(),
install_requires=[
'openpyxl>=3.0',
'requests>=2.0'
],
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires='>=3.6',
long_description=LONG_DESCRIPTION
)

if __name__ == "__main__":
setup_package()

0 comments on commit d05ab8f

Please sign in to comment.