stswn / amundsen-atlas-types

Atlas custom type definitions

Amundsen Atlas Types

Kickstart your Apache Atlas to support Amundsen using the prebuilt functions and required entity definitions.

Installation:

The package is available on PyPi, which you can install using below.

    pip install amundsenatlastypes

Usage:

Connecting to Apache Atlas:

amundsenatlastypes uses environment variables to connect to Apache Atlas.

Following are the environment variables need to be set in order to connect to Apache Atlas.

- ATLAS_HOST                [default = localhost]
- ATLAS_PORT                [default = 21000]
- ATLAS_USERNAME            [default = admin]
- ATLAS_PASSWORD            [default = admin]

Kickstart Apache Atlas

A single python function is available that you can use to apply all required entity definitions. You can run this function as many times as you want, and it will not break any existing functionality, that means that it can also be implemented in your pipelines.

from amundsenatlastypes import Initializer
    
init = Initializer()
init.create_required_entities()

There also is a functionality to initiate your existing data to work accordingly with Amundsen. To create required relations you need to set fix_existing_data=True while calling the create_required_entities().

from amundsenatlastypes import Initializer
    
init = Initializer()
init.create_required_entities(fix_existing_data=True)

Sample Data

amundsenatlastypes provides sample data so you can populate your Atlas not only with entity definitions but also concrete entities.

Prerequisites

pip install amundsenatlastypes[samples]

Table Sample Data

from amundsenatlastypes.schema.table.sample_data import SampleTableData

table_loader = SampleTableData()
table_loader.create()

Dashboard Sample Data

from amundsenatlastypes.schema.dashboard.sample_data import SampleDashboardData

# Fill below variables with appropriate values
table_guid = ''
user_guid = ''

loader = SampleDashboardData(table_guid, user_guid)

loader.create()

Functionality:

amundsenatlastypes provides a number of functions that can be used separately to implement/apply entity definitions of Apache Atlas, which are available here.

You can also simply access the individual entity definitions in JSON format by importing them from here.

Sample Data

amundsenatlastypes provides sample data so you can populate your Atlas not only with entity definitions but also concrete entities.