forked from jpoullet2000/atlasclient
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: verdan <verdan.mahmood@gmail.com>
- Loading branch information
Showing
2 changed files
with
82 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
### This repository is no longer maintained in favour of Official Apache Atlas' python client: <https://pypi.org/project/apache-atlas/> | ||
|
||
|
||
Apache Atlas Client in Python | ||
----------------------------- | ||
|
||
[![image](https://img.shields.io/pypi/v/pyatlasclient.svg)](https://pypi.python.org/pypi/pyatlasclient) [![image](https://img.shields.io/travis/verdan/pyatlasclient.svg)](https://travis-ci.org/verdan/pyatlasclient) [![image](https://coveralls.io/repos/github/verdan/pyatlasclient/badge.svg?branch=master)](https://coveralls.io/github/verdan/pyatlasclient?branch=master) [![Documentation Status](https://readthedocs.org/projects/pyatlasclient/badge/?version=latest)](https://pyatlasclient.readthedocs.io/en/latest/?badge=latest) [![Updates](https://pyup.io/repos/github/verdan/pyatlasclient/shield.svg)](https://pyup.io/repos/github/verdan/pyatlasclient/) | ||
|
||
Apache Atlas client in Python. Only compatible with Apache Atlas REST | ||
API **v2**. | ||
|
||
*Based on the awesome work done by Poullet in atlasclient* | ||
|
||
- Free software: Apache Software License 2.0 | ||
- Documentation: <https://pyatlasclient.readthedocs.io> | ||
|
||
### Get started | ||
|
||
```python | ||
from atlasclient.client import Atlas | ||
client = Atlas('<atlas.host>', port=21000, username='admin', password='admin') | ||
client.entity_guid("<guid>").status | ||
params = {'typeName': 'DataSet', 'attrName': 'name', 'attrValue': 'data', 'offset': '1', 'limit':'10'} | ||
search_results = client.search_attribute(**params) | ||
for s in search_results: | ||
for e in s.entities: | ||
print(e.name) | ||
print(e.guid) | ||
``` | ||
|
||
### Features | ||
|
||
- Lazy loading: requests are only performed when data are required and | ||
not yet available | ||
- Leverages Python\'s Data Classes for Glossary. | ||
- Resource object relationships: REST API from sub-resources are done | ||
transparently for the user, for instance the user does not have to | ||
know that it needs to trigger a different REST request for getting | ||
the classifications of a specific entity. | ||
|
||
### TODO features | ||
|
||
- allow multiprocessing | ||
- Implement Caching | ||
- Apply Data Classes to all entity types. For now only Glossary | ||
endpoints are using it. | ||
|
||
### Credits | ||
|
||
This package was created with | ||
[Cookiecutter](https://github.com/audreyr/cookiecutter) and the | ||
[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) | ||
project template. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters